Escribir codigo que otros puedan leer

Cuando realizamos algun proyecto propio escribimos el codigo como nos venga en gana , ponemos los nombres de variables a como queramos y las funciones pueden hacer mil y un cosas por que es nuestro codigo y nos importa un carajo quien lo vera.

Pero cuando trabajas para una empresa de desarrollo web tienes que seguir ciertas reglas para que tu codigo pueda ser leido y entendido por otros programadores , tu codigo puede hacer mil maravillas para si no esta bien escrito no servira de nada , mas aun si trabajas en una empresa donde vendes el codigo a otra empresa.Codeando javascript es que aprendi estas reglas que les mencionare a continuacion pero pueden aplicarse a cualquier otro lenguaje .

 Como deberias de escribir tu codigo , como deberias de nombrar a tus variables , como deberias de usar las llaves que abren y cierran un bloque de codigo , como deberias de estar estructurado tu codigo ?  todo eso importa cuando codeas  para ti y para todo tu equipo de desarrollo.

Queremos que el codigo sea legible.
Queremos que el codigo sea consistente.
Queremos que el codigo sea escrito con buenas practicas de estilo.

 Primero el  nombre de las variables

Tiene que ser lo mas exacto del dato que almacene , evita lo mas que puedas usar variables con nombre  a , b, c, temp  , esos nombre de variables no aportan nada cuando lees el codigo de otra persona  por ejemplo:

"sumaColores" esta variable por ejemplo nos dice que en ella esta almacenada la suma de los colores , como puedes notar para separar las palabras he escrito la C en mayuscula eso es CammelCase , escribir la primera letra de la segunda palabra de la variable con mayuscula para diferenciarla mejor , otros ejemplo son:  resultadoComprobacion , procesoFinal, tempCargar , ect.

Para los nombres de variables queremos claridad , significado , legibilida.

Segundo para los nombres de las funciones

Las funciones o metodos se escriben comenzando por un verbo que indican que alguna accion sera ejecutada para asi poder notar que son metodos o funciones , por ejemplo:

sumarDatos = function ( ) {  .....}    notar que la primera es un verbo con eso dejamos por sentado que es una funcion o metodo. en el caso de encontrar codigo como el siguiente :


resultadoFinal = sumaColores + sumarDatos();

aqui siguiendo el standar CammelCase  , sabemos que sumarDatos es una funcion no por que tenga los parentesis sino por que el verbo nos indica que va a sumar algo , asi es mas facil leer codigo de otra persona y siempre define tus funciones o metodos antes de llamarlos.

Algunas recomendaciones tambien son : Que tus funciones y tus metodos solo hagan una sola cosa , no pongas muchas tareas en una sola funcion o metodo , si es posible dividela en mas funciones  o metodos , entre mas simple mejor , asi el mantenimiento de codigo sera mas facil

Para las llaves puedes seguir estos ejemplos:

 if( operacion){
  ...........
}else {
 ...........
}

for ( operacion){
    .........
}

Abre la primera llave siempre en la primera linea del bloque de codigo y usa siempre Indentación con el tab , siempre que estes en un bucle for , if ,  ect.

En resumen siempre usa la tecnica de CammelCase en tus nombres de variables y funciones , abre la llave siempre en la misma linea donde comienza el bloque de codigo , define tus funciones antes de llamarlas y siempre usa Indentación .