Convenzioni di denominazione JavaScript [chiuso]

So che ci sono molte polemiche (forse non polemiche, ma almeno argomenti) su quale convenzione di denominazione è la migliore per JavaScript.

Come si nominano variabili, funzioni, oggetti e simili?

Lascerò i miei pensieri su questo, dato che non faccio JS da molto tempo (solo un paio d'anni) e ho appena ricevuto una richiesta per creare un documento con convenzioni di denominazione da utilizzare nei nostri progetti sul lavoro . Quindi ho cercato (google-ing) in giro, e ci sono così tante opinioni diverse.

I libri che ho letto su JS usano anche diverse convenzioni di denominazione, ma sono tutti d'accordo su un po ': "Trova ciò che ti si addice e seguilo." Ma ora che ho letto così tanto in giro, ho scoperto che alcuni degli altri metodi mi piacciono un po 'meglio di quelli a cui sono abituato ora.

Seguo le convenzioni sul codice di Douglas Crockford per javascript. Uso anche il suo strumento JSLint per convalidare seguendo tali convenzioni.

Come dice Geoff, ciò che dice Crockford è buono.

L'unica eccezione che seguo (e ho visto ampiamente usata) è usare $ varname per indicare un oggetto jQuery (o qualunque libreria). Per esempio

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

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

Puoi seguire questa guida di stile JavaScript di Google

In generale, utilizzare functionNamesLikeThis, variabileNamesLikeThis, ClassNamesLikeThis, EnumNamesLikeThis, methodNamesLikeThis e SYMBOLIC_CONSTANTS_LIKE_THIS.

EDIT: guarda la bella collezione di guide e abbellitori di stile JavaScript .

Una convenzione che vorrei provare è denominare i moduli statici con un prefisso "the". Controllalo. Quando uso il modulo di qualcun altro, non è facile vedere come dovrei usarlo. per esempio:

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

Sto pensando di provare una convenzione in cui i moduli statici usano "the" per indicare la loro preesistenza. Qualcuno ha visto un modo migliore di questo? Assomiglierebbe a questo:

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

Penso che oltre ad alcune limitazioni di sintassi; il ragionamento delle convenzioni di denominazione è molto indipendente dal linguaggio. Voglio dire, gli argomenti a favore di c_style_functions e JavaLikeCamelCase potrebbero ugualmente essere usati allo stesso modo, è solo che gli utenti del linguaggio tendono a seguire gli autori del linguaggio.

detto questo, penso che la maggior parte delle biblioteche tendano a seguire approssimativamente una semplificazione di CamelCase di Java. Trovo che i consigli di Douglas Crockford siano abbastanza raffinati per me.

Questa è una domanda individuale che potrebbe dipendere da come lavori. Ad alcune persone piace mettere il tipo di variabile all'inizio della variabile, come "str_message". E ad alcune persone piace usare il trattino basso tra le loro parole ("my_message") mentre ad altri piace separarle con lettere maiuscole ("myMessage").

Lavoro spesso con enormi librerie JavaScript con altre persone, quindi funzioni e variabili (eccetto le variabili private all'interno delle funzioni) iniziano con il nome del servizio per evitare conflitti, come "guestbook_message".

In breve: secondo me sono preferibili i nomi di variabili e funzioni inglesi, minuscole e ben organizzate. I nomi dovrebbero descrivere la loro esistenza piuttosto che essere brevi.