estandar de codificacion
Universidad Politécnica de Madrid
Facultad de Informática
PROCESOS Y ESTÁNDARES
(Ciclo 2)
__________________________________________
ESTÁNDAR DE CODIFICACIÓN Y RECUENTO DE LÍNEAS DECÓDIGO
Grupo 15
Historial de Versiones
Versión
Modificación
Realizado por
Revisado por
Aprobado por
Nº Petición Cambio
Estándar coficicación y recuento_c1_v1.0.docx
Entrega inicialÁlvaro Pérez
24/02/2009
Rubén Justo
25/02/2009
Álvaro Pérez
25/01/2009
13
ÍNDICE
1. ESTÁNDAR DE CÓDIGO
Este documento pretendedesarrollar un estándar a seguir para obtener un código de sencilla comprensión, con buena presencia y fácilmente legible.
Mediante el siguiente estándar se van a definir las pautas para escribir un fichero decódigo en lenguaje Java, durante la fase de codificación, con el fin de que todos los miembros del grupo de trabajo sigan un mismo estilo a la hora de programar, evitando así mal entendidos yhomogenizando el código.
1.1. Comentarios
Cada uno de los ficheros deberá incluir un código obligatorio que se corresponde con la identificación del autor y el grupo, además de la versión para llevar acabo el control de cambios correspondiente a través del GCS. También se deberá incluir el número de líneas de código para dar más información. El formato de este comentario será el siguiente:
/***
* Autor: Nombre
* Grupo: 15
* Versión: Nombre-c1-vX.X
* LOC: N
*/
El resto de comentarios se utilizarán para aclarar cualquier cuestión respecto al código pudiéndose utilizar tanto “//”para un comentario puntual en una línea o “/* */” para comentarios de varias líneas. Se podrán incluir tantos comentarios como sea necesario, sobre todo en las partes del código donde sea de vitalimportancia añadir información de interés para la comprensión.
1.2. Variables y constantes
Tanto las variables como las constantes se declararán en letra minúscula por completo y si están formadas...
Regístrate para leer el documento completo.