JavaScript adlandırma kuralları [kapalı]

JavaScript için en iyi adlandırma kuralı hakkında bir çok tartışma (belki de tartışma değil, en azından argümanlar) olduğunu biliyorum.

Değişkenlerinizi, fonksiyonlarınızı, nesnelerinizi ve benzerlerini nasıl adlandırıyorsunuz?

JS'yi uzun süredir (sadece birkaç yıldır) yapmadığım için kendi düşüncelerimi bunun dışında bırakacağım ve işteki projelerimizde kullanılacak adlandırma kurallarıyla bir belge oluşturma isteğim var . Bu yüzden etrafa bakıyordum (google-ing) ve çok farklı görüşler var.

JS'de okuduğum kitaplar da farklı adlandırma kuralları kullanıyor, ancak hepsi bir parça üzerinde anlaşıyorlar: “Size uygun olanı bulun ve ona sadık kalın.” Ama şimdi çok fazla okuduğum için, diğer yöntemlerden bazılarını şimdiye kadar kullandığımdan biraz daha iyi bulduğumu fark ettim.

Takip ettiğim Douglas Crockford kod kurallarına javascript için. Ben de bu kuralları takip etmek için onun JSLint aracını kullanın.

Geoff'un dediği gibi Crockford'un söyledikleri iyi.

Takip ettiğim (ve yaygın olarak kullandığım) tek istisna, jQuery (veya herhangi bir kitaplık) nesnesini belirtmek için $ varname kullanmaktır. Örneğin

var footer = document.getElementById('footer');

var $footer = $('#footer');

Bu Google JavaScript Stil Kılavuzunu takip edebilirsiniz

Genel olarak, functionNamesLikeThis, variableNamesLikeThis, ClassNamesLikeThis, EnumNamesLikeThis, methodNamesLikeThis ve SYMBOLIC_CONSTANTS_LIKE_THIS işlevlerini kullanın.

EDIT: JavaScript Stil Kılavuzları ve Güzelleştiriciler güzel bir koleksiyon bakın .

Denemek istediğim bir kural, statik modülleri 'the' önekiyle adlandırmaktır. Şuna bir bak. Başka birinin modülünü kullandığımda, onu nasıl kullanmam gerektiğini görmek kolay değil. Örneğin:

define(['Lightbox'],function(Lightbox) {
  var myLightbox = new Lightbox() // not sure whether this is a constructor (non-static) or not
  myLightbox.show('hello')
})

Statik modüllerin 'pre' varlığını belirtmek için kullandıkları bir konvansiyonu denemeyi düşünüyorum. Bundan daha iyi bir yol gören var mı? Şöyle görünür:

define(['theLightbox'],function(theLightbox) {
  theLightbox.show('hello') // since I recognize the 'the' convention, I know it's static
})

Bazı sözdizimi sınırlamalarının yanı sıra; adlandırma kuralları muhakemesi dilden çok bağımsızdır. Yani, c_style_functions ve JavaLikeCamelCase lehine argümanlar aynı şekilde iyi bir şekilde kullanılabilir, sadece dil kullanıcıları dil yazarlarını takip etme eğilimindedir.

Söyledikten, çoğu kütüphane kabaca Java CamelCase basitleştirme takip eğilimindedir düşünüyorum. Douglas Crockford'un tavsiyelerini benim için yeterince zevkli buluyorum .

Bu, nasıl çalıştığınıza bağlı olabilecek bireysel bir soru. Bazı insanlar değişken türünü "str_message" gibi değişkenin başına koymayı sever. Bazıları ise kelimeleri arasında alt çizgi kullanmayı ("my_message"), bazıları ise büyük harflerle ("myMessage") ayırmayı sever.

Sık sık diğer insanlarla büyük JavaScript kütüphaneleri ile çalışıyorum, bu yüzden işlevler ve değişkenler (işlevler içindeki özel değişkenler hariç) "guestbook_message" olarak çakışmaları önlemek için hizmetin adıyla başlamak zorunda.

Kısacası: bana göre ingilizce, alt kasalı, iyi organize edilmiş değişken ve fonksiyon isimleri tercih edilir. İsimler, kısa olmak yerine varlıklarını tarif etmelidir.