El blog de yylex

All hail FOSS!

Convenciones de nombrado en Java

Publicado por yylex en Abril 19, 2008

Las convenciones de nombrado hacen que los programas escritos sean más fáciles de entender porque facilitan la lectura del código. También pueden dar información sobre la función del identificador (por ejemplo, si se trata de una constante, un paquete o una clase) lo cual puede ser útil para entender el código.

Paquetes: Los nombres de paquetes siempre deben escribirse con letras ASCII minúsculas y deberían ser uno de los nombres de dominio de alto nivel, actualmente com, edu, gov, mil, net, org, o uno de los códigos de dos letras en inglés que identifican los países como se especifica en el estándar ISO 3166, 1981.

Además los componentes del nombre del paquete varían de acuerdo a las propias convenciones internas de nombrado de las organizaciones. Tales convenciones pueden especificar que ciertos nombres de componente directorio sean division, department, project, machine, o nombres de inicio de sesión.

Ejemplos:


com.sun.eng
com.apple.quicktime.v2
edu.cmu.cs.bovik.cheese

Clases: Los nombres de clases deberían ser sustantivos, incluyendo mayúsculas y minúsculas con la primer letra de cada palabra interna en mayúscula. Intente mantener los nombres de clases sencillos y descriptivos. Utilice palabras completas y evite usar acrónimos y abreviaturas (a menos que la abreviatura sea ampliamente usada más que la forma completa, tal como URL o HTML).

Ejemplos:

class Raster;
class ImageSprite;

Interfaces: Los nombres de interfaces deben tratarse igual que los nombres de clases.

Ejemplos:

interface RasterDelegate;
interface Storing;

Métodos: Los nombres de los métodos deberían ser verbos, mezclas de mayúsculas y minúsculas con la primer letra en minúscula y la primer letra de cada palabra interna en mayúscula.

Ejemplos:

run();
runFast();
getBackground();

Variables: Sin incluir las variables, todas las instancias, clases y constantes de clase se escriben usando mayúsculas y minúsculas con la primer letra en minúscula.  Las palabras internas comienzan con letras mayúsculas. Los nombres de variable no deben comenzar con caracteres underscore _ o signo de dólar $, aunque ambos estén permitidos.

Los nombres de variables deberían ser cortos pero con un significado claro. La elección de un nombre de variable debería ser mnemónica, es decir, diseñado para indicar al observador casual su utilización. Deberían evitarse los nombres de variable de un solo caracter excepto para las variables temporales. Algunos nombres de variables temporales son i, j, k, m, y n para enteros; c, d, y e para caracteres.

Ejemplos:

int i;
char c;
float myWidth;

Constantes: Los nombres de variables declarados como constantes de clase y las constantes ANSI deberían escribirse todas en mayúsculas con palabras separadas por underscores _. (Las constantes ANSI deberían evitarse, para facilitar la depuración.)

Ejemplos:

static final int MIN_WIDTH = 4;
static final int MAX_WIDTH = 999;
static final int GET_THE_CPU = 1;

Fuente: Code Conventions for the Java Programming Language > Naming Conventions

Una respuesta para “Convenciones de nombrado en Java”

  1. erikgiron escribió

    mmm, eso del nombre de variables esta bueno para la mara que acostumbra colocar su apodo para identificar la variable

Escribe un comentario

XHTML: Puedes usar estas etiquetas: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <pre> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>