Java
1. Evitar en lo posible definir variables globales. 2. No referirse a valores constantes (i.e. 4) directamente en el código, más bien utilizar el operadorfinal de Java para declarar constantes. 3. Proveer comentarios en cada línea de código obscuro o que sea difícil de leer. 4. Limitar todos los métodos a que realicen solo una tarea y moderar el númerode líneas de cada método (< 20). 5. Utilizar una indentación consistente. 6. Utilizar el siguiente bloque de comentario como plantilla para cada clase declarada:
/** * CRectangulo * Clase rectangulola cual contiene las operaciones * necesarias para la creacion y manipulacion de rectangulos * * @author Carlo Magurno * @version 1.00, 3/10/2000 * */
7. Utilizar el siguiente bloque de comentariopor cada metodo o procedimiento que se realiza:
/** * Nombre del Metodo Breve explicacion de lo que hace el metodo * * @param nombre Explicacion y tipo de parametro * @param nombre Explicacion y tipode parametro * * @return Explicacion del valor de retorno del metodo */
8. Cada clase será almacenada en un archivo, y cada archivo contendrá solo una clase. 9. Todos los atributos de una clasedeberán ser definidos con el operador private para así poder implementar un esquema puro de intercambio de mensajes y el encapsulamiento. 10. Los métodos de acceso (Get) y de modificación (Set) deberánser definidos sólo para aquellos atributos que necesiten ser accesados por otras clases. 11. Utilizar identificadores descriptivos para el nombre de métodos y atributos, evitando así abreviacionescrípticas.
12. Preceder todos los nombres de clases con la letra C (i.e. CRectangulo). 13. Utilizar mayúscula para la primera letra de cada clase, y de cada método (i.e. DibujaRectangulo()). 14.Comenzar cada atributo o variable local con letra minúscula (i.e. clave, cedulaIdentidad) 15. Capitalizar la primera letra de cada palabra en un nombre compuesto (i.e. entradaDatos, coordenadaX) 16....
Regístrate para leer el documento completo.