Değişkeninizi bir profesyonel gibi adlandırmak için 5 ipucu

Apr 28 2023
Bir geliştirici olarak her gün kod yazıyorsunuz. Size nasıl temiz kod yazılacağını göstereyim.
Fotoğraf: Crystal de Passillé-Chabot

Bir geliştirici olarak her gün kod yazıyorsunuz. Size nasıl temiz kod yazılacağını göstereyim.

İlk olarak, temiz kod yazmak neden önemlidir?

Çünkü, kod şöyle olmalıdır:

  • Bakım Yapılabilir : Kolayca okunur, anlaşılır ve değiştirilir.
  • Ölçeklenebilirlik : Yeni özellikler ekleyerek kolayca genişletmek.
  • Hata ayıklama: Hataları bulmak ve düzeltmek için kolayca.
  • İşbirliği : Başkaları tarafından kolayca anlaşılır.

Değişkenler, sınıflar, işlevler adlandırma veya genel olarak adlandırma, kodun büyük bir bölümünü oluşturur. Adlandırma kodun her yerindedir.

Kodunuzu temiz hale getirmek için izlemeniz gereken 5 adlandırma yasası vardır:

1. Niyet Açıklayan İsimler Kullanın

Adı okuduğunuzda, değişkenin tam olarak ne içerdiğini veya işlevin tam olarak ne yaptığını hızlı bir şekilde anlamalısınız.

Değişken

// bad
const var1 = 26;

// good
const age = 26;

// best
const userAge = 26;

İşlev

Öğüt : Fonksiyon ismini fiil ile başlatmak çok anlamlı.

type User = {
  firstname: string;
  lastname: string;
}

// bad
const print = (user: User) => {
  console.log(`${user.firstname} ${user.lastname}`);
}

// good
const printUser = (user: User) => {
  console.log(`${user.firstname} ${user.lastname}`);
}

// best
const printUserFullname = (user: User) => {
  console.log(`${user.firstname} ${user.lastname}`);
}

2. Dezenformasyondan Kaçının

Başka bir anlamı olmayan bir isim yazmaya çalışmalısın. Örneğin: kısaltma ve dil anahtar kelimesinden kaçının.

// bad
const orgPath = '../path/to/folder';

// good
const originPath = '../path/to/folder';

// bad
const userArray = [];

// good
const users = [];

İki farklı değişken arasında ayrım yapabilmeniz gerekir.

3. Anlamlı bir ayrım yapın

Değişken, sınıf veya fonksiyon isimlerini anlamlı kelime(ler) ile ayırt etmelisiniz.

3 arayüzümüz olduğunu hayal edin: User, UserInfo, UserData. Aralarındaki farkın ne olduğunu söyleyebilir misin? Hayır. Bunun yerine User, UserBasicInformation ve UserFormData kullanın.

4. Telaffuz Edilebilir İsimler Kullanın

Telaffuz edebileceğiniz bir isim kullanın.

// bad
const editmdhms;

// good
const editTimestamp;

Özellikle bir eşik değişkeniyle uğraşırken aranabilir bir ad kullanın.

// bad
const checkIsUserMajor = (user) => {
  if(user.age >= 18) {
    return true;
  } else {
    return false
  }
};

// good
const MIN_USER_MAJOR_AGE = 18;
const checkIsUserMajor = (user) => {
  if(user.age >= MIN_USER_MAJOR_AGE) {
    return true;
  } else {
    return false
  }
};

Çözüm

Adlandırma her yerde ve kodun çok önemli bir parçası. Ad ne kadar anlamlı olursa, kod o kadar temiz olur.

React'ten etkilendiyseniz, işte 8 dakikada React'i Öğrenin hakkındaki makalem.

https:///@mohamed.amine.haine/learn-react-in-8-minutes-7ab4c3c40d0f

Bu makale size yardımcı olduysa, lütfen bir beğeni verin. Ve temiz bir şekilde kod yazmanıza izin veren programlama kavramlarını seviyorsanız, şimdi abone olun, böylece hiçbir şeyi kaçırmazsınız.