Java Code Conventions I Partereferencia: http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.htmlPor que utilizar Java Code Conventions?Las Code Conventions son importantes para los programadores por las siguientes razones:
- No dedicanos el 80% del tiempo de vida del Sofware en darle mantenimiento.
- Rara vez el Software es mantenido por la misma persona que lo creo.
- Las Code Conventions mejoran la lectura de las líneas de código.
- Muchas veces el producto se vende con el código fuente y el seguir las Code Conventions le dan un valor agregado al producto.
Cómo nombrar clases, interfaces, métodos, atributos, constantes?CLASES:
- Los nombres de las clases deben ser sustantivos y con la primera letra en mayúscula, en caso de mezclar varios sustantivos la primera letra de cada palabra debe ir en mayúscula.
- Utilizar palabras completas, evitar abreviaciones y acronimos (a menos que sea de uso común como URL, HTML).
- Ejemplo: Message, User, ComboBox
INTERFACES:
- Debe ser nombradas de manera similar a las clases.
MÉTODOS:
- Los nombres de los métodos deben ser verbos y estar en minúsculas, en caso de tener un nombre compuesto, la primera letra a partir de la segunda palabra debe ir en mayúscula.
- Ejemplo: save(), delete(), findAll(), findById()
VARIABLES:
- Los nombres de las variables deben estar en minúsculas, en caso de tener un nombre compuesto, la primera letra a partir de la segunda palabra debe ir en mayúscula.
- Los nombres deben ser descriptivos de acuerdo al valor que contienen.
- Evitar nombres de una sola letra, a menos que se traten de variables auxiliarias como i, j, k... utilizadas para sentencias if, for, while...
- Ejemplo: name, address, width, height, firstName, lastName.
CONSTANTES:
- Los nombres de las constantes (public/private static final) deben estar en mayúsculas y separadas por "_" en caso de tener nombres compuestos.
- Ejemplo: public static final int MIN_WIDTH = 10, public static final int MAX_WIDTH = 1000.
Cuál es el tamaño recomendable de los archivos?- Una línea de código no debe sobrepasar los 80 caracteres.
- Un archivo no debe tener mas de 2000 líneas de código.
De cuántos espacios debe ser la unidad de indentación o sangría?- Debe ser de 4 espacios
Cuál es el formato para declarar una clase?public class Usuario {
// .....
}
Cual es el formato para declarar las sentencias principales?- Luego de la sentencia if, for, whiel, do, while, try, catch, siempre va un espacio en blanco
- Luego de (condicion), (init, condicion, aumento), (Exception1 e), siempre hay un espacio en blanco
- Es muy importante la posición de las llaves "{ }"
if (condicion) {
// .....
} else if (condicion) {
// .....
} else {
}
for (init, condicion, aumento) {
// ......
}
while (condicion) {
}
do {
} while (condicion);
switch (codicion) {
case ABC:
// ......
case DGC:
// ......
break;
default:
// .....
break;
}
try {
// .....
} catch (Exception1 e) {
// .....
} catch (Exception2 e) {
// .....
} finaly {
// .....
}
