Convenciones de codificación en Java

Como todo lenguaje, existen unas reglas de nombramiento para cada uno de los componentes que lo caracterizan, en este caso se expondran sus respectivos identificadores.

Clases

  • Los nombres de las clases deben ser sustantivos y en singular.
  • cuando son compuestos tendrán la primera letra de cada palabra que lo forma en mayúsculas (notación pascal case).
  • Intentar mantener los nombres de las clases simples y descriptivos.
  • Usar palabras completas, evitar acrónimos y abreviaturas (a no ser que la abreviatura sea mucho más conocida que el nombre completo, como URL or HTML).

Ejemplos: Cliente, OrdenCompra

Paquetes

  • El prefijo del nombre de un paquete se escribe siempre con letras ASCII en minúsculas, y debe ser uno de los nombres de dominio de alto nivel, actualmente com, edu, gov, mil, net, org, o uno de los códigos ingleses de dos letras que identifícan cada país como se especifica en el ISO Standard 3166, 1981.
  • Los subsecuentes componentes del nombre del paquete variarán de acuerdo a las convenciones de nombres internas de cada organización. Dichas convenciones pueden especificar que algunos nombres de los directorios correspondan a divisiones, departamentos, proyectos o máquinas.

Ejemplos: com.sun.eng co.gov.antioqua

Interfaces

  • Los nombres de las interfaces siguen la misma regla que las clases.
  • Algunas empresas le anteponen la i mayúscula (I) como prefijo, sin embargo, el libro clean code se recomienda simplemente el nombre

Ejemplos: Cliente, OrdenCompra

Métodos

  • Los métodos deben empezar con verbos en infinitivo (ar, er, ir).
  • Cuando son compuestos tendrán la primera letra en minúscula, y la primera letra de las siguientes palabras que lo forma en mayúscula (Notación camel case). ejemplos: numeroEstudiantes, notaDefinitiva.

Es muy común ver los verbos get o set para nombrar los métodos en ingles, en español también pueden ser nombrados por algunos verbos, por ejemplo: obtenerPago(), insertar().

Variables

  • Excepto las constantes, todas las instancias y variables de clase o método empezarán con minúscula.
  • Las palabras internas que lo forman (si son compuestas) empiezan con su primera letra en mayúsculas.
  • Los nombres de variables no deben empezar con los caracteres subguión «_» o signo del dolar «$», aunque ambos estan permitidos por el lenguaje.
  • Los nombres de las variables deben ser cortos pero con significado. La elección del nombre de una variable debe ser un mnemónico, designado para indicar a un observador casual su función.
  • Los nombres de variables de un solo caracter se deben evitar, excepto para variables índices temporales. Nombres comúnes para variables temporales son i, j, k, m;

Ejemplos: totalEstudiantes, edad.

Constantes

Los nombres de las variables declaradas como constantes deben ir totalmente en mayúsculas separando las palabras con un subguión («_»).

Ejemplos: static final int ANCHURA_MINIMA = 4,static final int ANCHURA_MAXIMA = 999; static final int COGER_LA_CPU = 1