Escolar Documentos
Profissional Documentos
Cultura Documentos
Sistemas integrales
Introduccin
Se definen un estndar de codificacin porque es un estilo de programacin homogneo en un proyecto permite que todos los participantes lo puedan entender en menos tiempo y que el cdigo en consecuencia sea mantenible.
Nombres de ficheros
Sufijos de ficheros en Java1: Cdigo fuente: .java Cdigo compilado: .class Nombres de ficheros comunes: README: Resumen de informacin importante relativa al directorio en el que est ubicado
Organizacin de ficheros
Un fichero consta de secciones separadas por lneas en blanco y lneas de comentario, ningn fichero debe tener ms de 2000 lneas de cdigo.
Indentacin
La unidad de indentacin de bloques de sentencias son 4 espacios
Lneas largas
Cuando una lnea no quepa en una nica lnea se debe fraccionar atendiendo a estos principios generales. Fraccionar despus de una coma Fraccionar despus de un operador
Es mejor romper unidades de alto nivel que de bajo nivel. Ejemplo: longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; // Mejor longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; // Peor Si las reglas anteriores producen cdigo confuso utilizar indentacin de 8 caracteres. Ejemplo: // NO USAR ESTA INDENTACION if ((condition1 && condition2) || (condition3 && condition4) ||!(condition5 && condition6)) { doSomethingAboutIt(); // SE CONFUNDE CON LAS ANTERIORES } // USAR ESTA INDENTACION if ((condition1 && condition2) || (condition3 && condition4) ||!(condition5 && condition6)) { doSomethingAboutIt(); } // O ESTA if ((condition1 && condition2) || (condition3 && condition4) ||!(condition5 && condition6)) { doSomethingAboutIt(); }
Comentarios
Normas general a seguir en toda documentacin: 1. Los comentarios deben aadir claridad al cdigo. 2. Deben contar el por qu y no el cmo. 3. Deben ser concisos. 4. Idealmente hay que escribir la documentacin antes que el cdigo. Hay dos tipos de comentarios: Comentarios de implementacin y comentarios de documentacin. Los comentarios de implementacin son del tipo: // ... o /* ... */. Los comentarios de documentacin son del tipo: /** ... */. Los comentarios de implementacin describen el cdigo, los de documentacin una visin de ms alto
Comentarios de implementacin
Comentarios de bloque: Al comienzo de cada fichero o bloque. No se usan en este proyecto Comentarios de linea: Son comentarios explicativos de una parte pequea del cdigo. Sintaxis: // ... o /* ... */
Comentarios de documentacin
Son los comentarios destinados a ser procesados por javadoc. Importante: No se pueden usar comentarios de documentacin para bloques de cdigo dentro de mtodos porque javadoc los asigna a la primera declaracin que encuentre detrs de ellos La indentacin correcta es: /** * Comentario sobre la clase A */ public class A { ... }
Inicializacin
Inicializar cada variable en su declaracin a menos que su valor inicial dependa de algn clculo
Localizacin
En el comienzo de los bloques. La nica excepcin es el bucle for. No se deben declarar variables con el mismo nombre que otras en un mtodo
Sentencias compuestas
Son las que estn entre llaves { y } Deben estar indentadas a un nivel superior que el precedente Todas las sentencias del tipo if o for, while, do ... while debern tener llaves aunque slo contengan una sentencia, de esta forma se evita la introduccin accidental de errores si se aaden posteriormente sentencias
Ejemplos:
Sentencia if if (condition) { statements; } if (condition) { statements; } else { statements; } if ( condition) { statements; } else if (condition) { statements; } else { statements; }
Sentencias de retorno
No se pondr la expresin de retorno entre parntesis a menos que con ello se gane en claridad
Caracteres de espacio
Se deben usar en las siguientes circunstancias: Entre un parntesis cerrado y una llave Despus de una coma en la lista de parmetros de un mtodo Entre operadores binarios: +, -, =, etc. Nunca entre un operador uno-ario y su operando La sentencia for y su parntesis. Ejemplo: for (expr1, expr2, expr3); Casts. Ejemplo: myMethod((int) (cp 5), ((int) (i + 3)) + 1);+
Asignacin de nombres
Esta es la seccin ms importante. Las normas genricas son: Se usan descriptores en ingls que dejan claro el cometido de la variable, mtodo o clase. Se usa terminologa aplicable al dominio.