Conveciones De Estilo De Código Para Javascript

Convenciones de Código para la Programación en el Lenguaje JavaScript De: Douglas Crockford Traducción: Armando Robert Lobo Este es un conjunto de convenciones de codificación y reglas para su uso en la programación con JavaScript. Se inspira en el documento “Code Conventions for the Java Programming Language” de Sun. Ha sido consecuentemente modificado puesto que JavaScript no es Java. A largoplazo el valor del software para una organización está en proporción directa con la calidad del código base. Durante su ciclo de vida un programa será visto y manipulado por muchos pares de ojos y manos. Si el código logra comunicar con claridad su estructura y características es poco probable que pueda ser dañado por modificaciones que se realicen en un futuro por distante que sea. Lasconvenciones de código nos ayudan a reducir la fragilidad de los programas. Todo nuestro código JavaScript va a ser enviado directamente al público. Este siempre evaluará la calidad con que se ha editado. Cuentan con la limpieza. Archivos JavaScript Los programas en JavaScript siempre deben ser alojados en archivos con extensión “.js”. Debe evitarse embeber código en el HTML salvo que este pertenezca a unescenario específico. El código en el HTML incrementa de manera significativa el peso de una página eliminando las oportunidades de mejorar el rendimiento a través de la compresión y el cacheo. Las etiquetas deben ser ubicadas los más abajo posible en el body del documento. Reduciendo así el efecto de retardo asociado a los scripts que afecta la carga de otros componentes de la página. No sonnecesarios el uso de los atributos type o language. Es el servidor, no la etiqueta del script, el que determina el tipo MIME del contenido.
(Nota del traductor, no presente en el documento original) Cuando se trate de una función constructora (similar a lo que entenderíamos por una clase en JavaScript) el nombre del archivo debe ser idéntico al de la función y encontrarse en la ubicacióncorrespondiente al convenio para espacios de nombre (generalmente una carpeta para cada paquete).

Identación La unidad de identado es de 4 espacios. El uso de la tabulación debe ser evitado porque (tal como se escribía en el siglo pasado) no existe un estándar que determine con precisión el ancho que va a producir la tabulación.1 El uso de espacios produce ficheros más largos, pero en una red local esto noes significativo, y la diferencia puede ser eliminada con compresión.
1 (Nota del traductor, no presente en el documento original) Algunos IDE (entre ellos Netbeans) pueden ser configurados de modo tal que la tabulación se traduzca en una cantidad determinada de caracteres, resolviendo este dilema.

Longitud de la Línea Evitar lineas con más de 80 caracteres. Cuando una sentencia sobrepase unalínea simple del editor, esta deber ser separada en otras. Realice la separación después de un operador, preferentemente luego de una coma. Realizar la ruptura después de un operador disminuye la probabilidad de que al realizar un copiado del código se cometa un error por olvido de la inserción del punto y coma. La siguiente línea debe ser identada con 8 espacios. Comentarios Sea benevolente conlos comentarios. Es conveniente dejar información que pueda ser leída tiempo después por personas (posiblemente usted mismo) que necesitan entender que fue lo que se hizo en el fragmento de código. Los comentarios deben ser escritos correctamente y claros, tal como debe ser un buena nota de clase. Ocasionalmente un poco de humor es apreciado. Frustración y resentimiento no son bienvenidos. Esimportante que los comentarios sean actuales. Los comentarios erróneos pueden hacer del programa algo difícil de leer y comprender. Escriba comentarios significativos. Concéntrese en aquellos fragmentos del código donde puede no resultar obvio lo que se hace. No desperdicie el tiempo de sus lectores con cosas semejantes a: i = 0; // Pone el valor de i en 0. Generalmente deben usarse comentarios de...