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; |