Material de estudio  >  Apuntes  >  Escritura de programas  >  Nomenclatura

Nomenclatura

José A. Mañas <jmanas@dit.upm.es>
Dept. de Ingeniería de Sistemas Telemáticos
Universidad Politécnica de Madrid
8 de mayo, 2003

1. Introducción

Los nombres de clases, variables y métodos son un mecanismo básico para transmitir al lector lo que piensa en programador.

En principio, cualquier convenio sería bueno, con el único requisito de que se siguiere sistemáticamente.

A continuación se describe el convenio más habitual en la comunidad de programadores Java.

2. Reglas de nomenclatura

REGLA GENERAL:
cuando un nombre conste de varias palabras, se escribirán una tras otra, sin solución de continuidad, comenzando cada palabra por mayúscula.
  VariableDeTresPalabras
  NumeroDeTelefonosEnLaOficina
Las excepciones a esta regla general se señalan en cada caso.

2.1. Los nombres de los paquetes deben usar solo minúsculas.
  package lprg.p7;

2.2. Los nombres para las clases deben ser sustantivos.
Se sigue la REGLA GENERAL.
  ColaLlamadas, Estancia, ListaDeNombres

2.3. Los nombres de las variables siguen la REGLA GENERAL;
pero la primera letra será minúscula.
  int numeroDeCarneros;

2.4. Las constantes ("variables" final) se escribirán íntegramente con mayúsculas.
Si constan de varias palabras, se separarán estas por "_".
  static final int COLOR_ROJO= 0xFF0000;

2.5. Los nombres de los métodos deben ser verbos.
Se sigue la REGLA GENERAL;
pero la primera letra será minúscula.
  String getNombre ();
void setNombre(String string);

2.6. Si una palabra es un acrónico,
se sigue la REGLA GENERAL de escribir solo el primer carácter con mayúscula (con las salvedades antes apuntadas).
  class Dni
  dniDelSujetoPasivo
  getUrl()

3. Referencias