Konwencje nazewnictwa JavaScript

Question

Wiem, że istnieje wiele kontrowersji (może nie kontrowersji, ale przynajmniej argumentów), o tym, która konwencja nazw jest najlepsza dla JavaScript.

Jak nazywasz swoje zmienne, funkcje, obiekty i tym podobne?

Zostawię moje własne przemyślenia na ten temat, ponieważ nie robiłem JS przez długi czas (tylko kilka lat), i właśnie dostałem prośbę o utworzenie dokumentu z konwencjami nazewnictwa do użycia w nasze projekty w pracy. Tak więc szukałem (google-ing) wokół i jest tak wiele różnych opinii.

Książki, które czytałem na JS, również używają różnych konwencji nazewnictwa, ale wszystkie zgadzają się co do jednego: "Znajdź to, co ci odpowiada i trzymaj się tego." Ale teraz, gdy tak dużo czytałem w okolicy, Zauważyłem, że niektóre z innych metod są lepsze od tego, do czego jestem przyzwyczajony.

Answer 1

Podążam za Douglas Crockford's code conventions dla javascript. Używam również jego narzędzia JSLint do sprawdzania zgodności z tymi konwencjami.

Answer 2

Myślę, że oprócz pewnych ograniczeń składni; Konwencje dotyczące nazewnictwa są bardzo niezależne od języka. Chodzi mi o to, że argumenty na rzecz c_style_functions i JavaLikeCamelCase mogłyby równie dobrze być użyte w odwrotny sposób, po prostu użytkownicy języka zwykle podążają za autorami języków.

powiedziawszy to, myślę, że większość bibliotek ma tendencję do z grubsza postępować zgodnie z uproszczeniem CamelCase Java. Uważam, że dla mnie jest to gustowny gust.

Answer 3

To indywidualne pytanie, które może zależeć od tego, jak pracujesz. Niektórzy ludzie lubią umieszczać typ zmiennej na początku zmiennej, np. "Str_message". Niektórzy ludzie lubią używać podkreślenia między swoimi słowami ("my_message"), podczas gdy inni lubią rozdzielać je dużymi literami ("myMessage").

Często pracuję z dużymi bibliotekami JavaScript z innymi osobami, więc funkcje i zmienne (z wyjątkiem prywatnych zmiennych wewnątrz funkcji) zaczynają się od nazwy usługi, aby uniknąć konfliktów, jak "guestbook".

W skrócie: preferowana jest angielska, dobrze zorganizowana nazwa zmiennej i funkcji, według mnie. Nazwy powinny raczej opisywać ich istnienie niż być krótkie.

Answer 4

Jak mówi Geoff, co jest dobre Crockford says.

Jedynym wyjątkiem, którym podążam (i szeroko widziałem), jest użycie zmiennej $ nazwa_zmiennej do wskazania obiektu jQuery (lub innej biblioteki). Na przykład.

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

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

Answer 5

Możesz śledzić ten Google JavaScript Style Guide

Generalnie stosowanie functionNamesLikeThis, variableNamesLikeThis, ClassNamesLikeThis, EnumNamesLikeThis, methodNamesLikeThis i SYMBOLIC_CONSTANTS_LIKE_THIS.

EDYCJA: Zobacz ładny zbiór JavaScript Style Guides And Beautifiers.

Answer 6

Jedną z konwencji, którą chciałbym wypróbować, jest nazewnictwo modułów statycznych z prefiksem "the". Sprawdź to. Kiedy używam modułu innej osoby, nie jest łatwo zobaczyć, jak mam z niego korzystać.np .:

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

Zastanawiam się nad wypróbowaniem konwencji, w której statyczne moduły używają "tego" do wskazania swojej preegzystencji. Czy ktokolwiek widział lepszą drogę niż to? Wyglądałby tak:

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