que - Convenciones de nombres de JavaScript

que es html y javascript

Question

Sé que hay mucha controversia (quizás no controversia, pero al menos argumentos) sobre qué convención de nombres es la mejor para JavaScript.

¿Cómo nombras tus variables, funciones, objetos y demás?

Dejaré mis propios pensamientos sobre esto, ya que no he estado haciendo JS por mucho tiempo (solo un par de años), y acabo de recibir una solicitud para crear un documento con convenciones de nomenclatura para ser utilizado en nuestros proyectos en el trabajo. . Así que he estado mirando (google-ing), y hay muchas opiniones diferentes.

Los libros que he leído en JS también usan diferentes convenciones de nomenclatura, pero todos están de acuerdo en un momento: "Encuentra lo que más te convenga y apégate a él". Pero ahora que he leído mucho, descubrí que Como algunos de los otros métodos, un poco mejor de lo que estoy acostumbrado ahora.

Answer 1

Como dice Geoff, lo que dice Crockford es bueno.

La única excepción que sigo (y he visto ampliamente utilizada) es usar $ varname para indicar un objeto jQuery (o cualquier biblioteca). P.ej

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

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

Answer 2

Creo que además de algunas limitaciones de sintaxis; Las convenciones de nomenclatura de razonamiento son muy independientes del lenguaje. Quiero decir, los argumentos a favor de c_style_functions y JavaLikeCamelCase también podrían usarse de la manera opuesta, es solo que los usuarios del lenguaje tienden a seguir a los autores del idioma.

Dicho esto, creo que la mayoría de las bibliotecas tienden a seguir más o menos una simplificación de CamelCase de Java. Encuentro los consejos de Douglas Crockford lo suficientemente buenos para mí.

Answer 3

Esa es una pregunta individual que podría depender de cómo trabajas. A algunas personas les gusta poner el tipo de variable al principio de la variable, como "str_message". Y a algunas personas les gusta usar el subrayado entre sus palabras ("my_message"), mientras que a otras les gusta separarlas con letras mayúsculas ("myMessage").

A menudo trabajo con bibliotecas de JavaScript con otras personas, por lo que las funciones y variables (excepto las variables privadas dentro de las funciones) comenzaron con el nombre del servicio para evitar conflictos, como "guestbook_message".

En resumen: los nombres de funciones y variables en inglés, en mayúsculas y minúsculas son preferibles según mi criterio. Los nombres deben describir su existencia en lugar de ser cortos.

Answer 4

Puedes seguir esta guía de estilo de Google JavaScript.

En general, use functionNamesLikeThis, variableNamesLikeThis, ClassNamesLikeThis, EnumNamesLikeThis, methodNamesLikeThis y SYMBOLIC_CONSTANTS_LIKE_THIS.

EDITAR: Ver buena colección de guías de estilo de JavaScript y embellecedores .

Answer 5

Sigo las convenciones de código de Douglas Crockford para javascript. También utilizo su herramienta JSLint para validar siguiendo esas convenciones.

Answer 6

Una convención que me gustaría probar es nombrar módulos estáticos con el prefijo ''the''. Mira esto. Cuando uso el módulo de otra persona, no es fácil ver cómo se supone que debo usarlo. p.ej:

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

Estoy pensando en probar una convención donde los módulos estáticos usan "the" para indicar su preexistencia. ¿Alguien ha visto una manera mejor que esta? Se vería así:

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