 Tutoriales Convenciones de Codificación en Java
Convenciones de Nombrado
Las convenciones de nombrado hacen los programas más entendibles haciéndolos más fáciles de
leer. También pueden proporcionar información sobre la función del identificador, por ejemplo,
si es una constante, un paquete o una clase, lo que puede ayudarnos a entender el código.
Tipo de
Identificador |
Reglas de Nombrado |
Ejemplos |
| Paquetes |
Los prefijos de un nombre de paquete único siempre se escribien en letras ASCII minúsculas
y deberían ser uno de los nombres de dominos de alto nivel, actualmente com, edu,
gov, mil, net, org, o uno de los codigos de dos letras que identifican los paísies
como especifica el estándard ISO 3166, 1981.
Los siguientes componentes del nombre de paquete varían de acuerdo a las convenciones de
nombrado internas de una organización. Dichas convenciones podrían especificar que ciertos
nombres de componentes directorio serían división, departamento, proyecto, máquina, o nombres
de login.
|
com.sun.eng
com.apple.quicktime.v2
edu.cmu.cs.bovik.cheese
|
| Clases |
Los nombres de clases deben ser mezclas de mayúsculas y minúsculas, con la primera letra
de cada palabra interna en mayúsculas. Debemos intentar mantener los nombres de clases simples
y descriptivos. Debemos usar palabras completas y evitar acrónimos y abreviaturas (a menos que
la abreviatura se use muy ampliamente como URL o HTML). |
class Raster;
class ImageSprite;
|
| Interfaces |
Los nombres de interfaces se tratan igual que los nombres de clases |
interface RasterDelegate;
interface Storing;
|
| Métodos |
Los métodos deberían ser verbos, en mayúsculas y minúsculas con la primera letra del nombre
en minúsculas, y con la primera letra de cada palabra interna en mayúsculas. |
run();
runFast();
getBackground();
|
| Variables |
Las variables, tanto de ejemplar, de clase, como las constantes de clase se escriben en
mayúsculas y minusculas y con la primera letra del nombre en minúsculas, y con la primera
letra de cada palabra interna en mayúsculas. Los nombres de variables no deben empezar con los
caracteres subrayado "_" o dollar "$", incluso aunque estén permtidos.
Los nombres de variables deberían ser cortos y llenos de significado. La elección de una
variable debería ser mnemónica-es decir, diseñada para indicar al observador casual su
utilización. Se deben evitar los nombres de variable de un sólo caracter, excepto para variables
temporales. Algunos nombres comunes de este tipo de variables son: i, j, k, m, y n para enteros.
|
int i;
char c;
float myWidth;
|
| Constantes |
Los nombres de variables constantes de clases y las constantes ANSI deberían
escribirse todo en mayúsculas con las palabras separadas por subrayados (“_”).
(Se deberían evitar las constantes ANSI para facilitar la depuración.) |
static final int MIN_WIDTH = 4;
static final int MAX_WIDTH = 999;
static final int GET_THE_CPU = 1;
|
|
|
|
