NORMATIVA DE CÓDIGO
Antes de iniciar el desarrollo de un proyecto de software es necesario que todo el equipo que
participa en él establezca un estándar de codificación aceptado por todos los miembros con el
fin de garantizar una mejor coordinación.
Hemos creado una serie de normas y recomendaciones y hemos puesto en práctica en el
código aquellas escritas en negrita como ejemplo de uso:
•
NOMENCLATURA:
• No se permite el uso de ñ, Ñ, Ç o tildes.
• Las variables locales públicas comenzarán con “V_” seguido del nombre
deseado en minúscula. Además, es necesario que tengan entre 3 y 10
caracteres. Ej: public String V_nombre
• Las constantes se escribirán en mayúsculas.
• El nombre de los paquetes se escribirá en minúscula y comenzarán con
“pack_”. Ej: pack_paquete
• El nombre de los métodos debe escribirse en mayúsculas y debe tener entre
3 y 20 caracteres.
• El nombre de las variables pasadas por parámetro en los métodos comenzará
con “P_” y se seguirá de su nombre únicamente escrito en minúsculas.
• El nombre de las clases e interfaces se escribirá con la inicial en mayúscula.
• En caso de que las clases o interfaces tengan nombre compuesto se utilizará la
nomenclatura Pascal (uso de las iniciales en mayúscula).
• No se permite el uso de guiones en los nombres de los elementos definidos
por el programador (variables, clases, métodos), se recomienda utilizar barra
baja en métodos al estar escritas en mayúsculas.
•
CLASES E INTERFACES:
• Cada clase debe tener al comienzo una leyenda de derechos de autor en
donde debe aparecer: “//autor:”
• Se debe realizar mediante un comentario una breve descripción al inicio de
cada clase o interfaz.
• Se permite que los parámetros de los constructores de las clases tengan el
mismo nombre que los atributos y, para ello, se usará this.atributo=parámetro
para distinguirlos.
•
MÉTODOS:
• Antes de definir un método se debe realizar una breve descripción del objetivo
de éste.
• El tamaño de los métodos se restringe a 83 líneas de código. En caso de
necesitar más código se recomienda hacer una llamada a otro método.
• En caso de que los argumentos no quepan en una misma línea de código se
escribirán en una nueva línea a partir de la apertura del paréntesis de la
anterior.
• Un método puede constar con hasta un máximo de siete parámetros.
•
IDENTACIÓN:
• La identación del código se realizará de forma anidada.
• Los comentarios deben estar identados acorde con la identanción del código.
•
LLAVES:
•
•
En instrucciones como bucles o condicionales (for, while, do while, if, switch)
será obligatorio el uso de llaves aunque contengan sólo una sentencia.
• Las llaves se abrirán al finalizar la línea de código que genera dicho bloque de
código.
• Las instrucciones contenidas en el bloque delimitado por las llaves se
escribirán en una línea nueva después de la apertura, es decir, no se permite
código en la misma línea de apertura de la llave.
• El cierre se colocará aislado en una línea donde no haya ninguna instrucción.
• El cierre de la llave se identará acorde con el comienzo de la instrucción que la
genera.
INSTRUCCIONES:
• No se permitirá más de una declaración por línea.
• En sentencias de tipo for se admite la declaración de la variable que lo recorre
en la misma sentencia.
• En sentencias donde se utilicen operadores aritméticos o de comparación se
dejará un espacio delante y detrás de cada uno. Ej: int s = a + b; Ej incorrecto:
int s=a+b;
• Las declaraciones de variables se separarán con una línea vacía entre ellas.
• Ej: public int V_var1
//línea vacía
public intV_var2
• No se permite el uso de break para finalizar bucles salvo en caso de switch ya
que es obligatorio. En su lugar se recomienda utilizar variables booleanas.
• Si se necesita más de una línea para realizar un comentario, se continuará en
otra línea nueva.
• Las líneas no pueden exceder de 120 caracteres.
ALUMNAS:
•
•
100383563 - ALICIA ROMERA GÓMEZ
100383419 - LAURA SÁNCHEZ CERRO