Kodunuz olabildiğince okunaklı ve temiz olmalıdır.
Aslında bu programlama sanatıdır – karmaşık bir görevi alın ve bunu olabildiğince doğru ve okunaklı bir şekle getirin.
Buna yardımcı olan bir şey de iyi kodlama stilidir.
Yazım
Kodlar için yazılmış bir kopya kağıdı (detayları aşağıda):
Şimdi bu kurallar ve nedenleri hakkında konuşabiliriz.
Buradaki hiçbir şey kanun değildir. Hepsi sizin zevkinize kalmıştır ve değişebilir. Buradaki kodlama kuralları dogmalara dayanmaz.
Süslü Parantez
Çoğu JavaScript projesinde süslü parantezler yeni satırda değil de kod ile aynı satırda yazılırlar. Buna “mısırlı” stili denir. Ayrıca süslü parantezin başında aşağıdaki gibi boşluk bırakılır.
if (kosul) {
// şunu yap
// ...bunu yap
// ...sonra bunu yap
}
Tek satırlı if cümlelerinde süslü parantez kullanmalı mı ? Kullanılacaksa nasıl yazılmalı?
Burada not düşülerek if örnekleri verilmiş. Siz de bu kodların okunabilirliğini yargılayabilirsiniz.
- Süslü parantez açma ve kapama aynı satırda yapılmış: Burada süslü paranteze gerek yok.
- Ayrı bir satıra süslü parantez olmadan yazılmış. Bu şekilde yazmayın. Bu ileride bazı anlayamadığınız hatalara neden olabilir. Örneğin
ifgövdesine bir satır daha yazarsanız bu satırlardan sonraki yazdığınız çalışmaz. - Süslü parantez olmadan tek satırda işi bitirebilirseniz kabul edilebilir. Ama kısa olması şartıyla.
- Bunların içerisindeki en iyisi.
Özetle:
- Çok kısa kodlar için, şu şekilde kullanım kabul edilebilir:
if(koşul) return null. - Eğer ayrı satırlara yazmanız gerekiyorsa kesin süslü parantez kullanın.
Satır uzunluğu
En uzun satır boyunun bir sınırı olmalı. Kimse yatayda kodu takip etmek istemez. Eğer o kadar uzun ise yeni bir satıra geçmeniz önerilir.
Satır uzunluğu limitine takım seviyesinde karar verilir. Genelde 80-120 karakter arasındadır.
Satır başı boşlukları
İki türlü satır başı standardı vardır.
-
Yatay boşluklar:2(4) boşluk.
Yatay boşluklar genelde 2 veya 4 veya “Tab” sembolünden oluşur. Bunlardan hangisinin seçilmesi gerektiği bir çeşit savaştır. Bugünlerde boşluk tuşu ile boşluk bırakmak daha fazla kullanılan yöntemdir.
Boşluk tuşu ile satıra başlamanın “Tab” a göre üstünlüğü daha esnek ayarlanabilir olmasından dolayıdır.
Örneğin argümanlar şu şekilde hizalanabilir:
goster(parametreler, hizalandı, // soldan 5 boşluk ilki, sonra, digeri ) { // ... } -
Dikey boşluk: mantıksal blokları ayırmak için satır arası bırakmak
En basit bir fonksiyonda bile mantıksal blokları ayırma ihtiyacınız olabilir. Aşağıdaki örnekte, değişkenlerin tanımlanması ve sonucun dikey olarak ayrılmasına dikkat edin:
function üst(x, n) { let sonuc = 1; // <-- for (let i = 0; i < n; i++) { sonuc *= x; } // <-- return sonuc; }Eğer okunurluluğa etki edecekse yeni bir satır arası vermekten çekinmeyin. Kanıya göre 9 satırdan fazla kod varsa arada kesin bir satır arası olmalıdır.
Noktalı virgül
Her cümlenin sonuna noktalı virgül konulmalıdır. Tercihli olsa bile tercih her zaman noktalı virgül tarafında olmalıdır.