Convenciones de nombres

Download java eBook

Ejemplo

Nombres de paquetes

  • Los nombres de los paquetes deben estar en minúsculas sin guiones bajos u otros caracteres especiales.
  • Los nombres de los paquetes comienzan con la parte de autoridad anulada de la dirección web de la empresa del desarrollador. Esta parte puede ser seguida por una subestructura de paquete dependiente de la estructura del proyecto / programa.
  • No utilice la forma plural. Siga la convención de la API estándar que utiliza, por ejemplo, java.lang.annotation y no java.lang.annotations .
  • Ejemplos: com.yourcompany.widget.button , com.yourcompany.core.api

Clase, Interfaz y Nombres Enum

  • Los nombres de clase y enumeración deben ser nombres.
  • Los nombres de las interfaces normalmente deben ser sustantivos o adjetivos que terminen con ... capaces.
  • Use mayúsculas y minúsculas con la primera letra de cada palabra en mayúsculas (es decir, CamelCase ).
  • Empareja la expresión regular ^[AZ][a-zA-Z0-9]*$ .
  • Use palabras completas y evite usar abreviaturas a menos que la abreviatura se use más ampliamente que la forma larga.
  • Formatee una abreviatura como una palabra si es parte de un nombre de clase más largo.
  • Ejemplos: ArrayList , BigInteger , ArrayIndexOutOfBoundsException , Iterable .

Nombres de los métodos

Los nombres de los métodos suelen ser verbos u otras descripciones de acciones

  • Deben coincidir con la expresión regular ^[az][a-zA-Z0-9]*$ .
  • Use mayúsculas y minúsculas con la primera letra en minúsculas.
  • Ejemplos: toString , hashCode

Variables

Los nombres de las variables deben estar en mayúsculas y minúsculas con la primera letra en minúscula

  • Empareja la expresión regular ^[az][a-zA-Z0-9]*$
  • Recomendación adicional: Variables
  • Ejemplos: elements , currentIndex

Variables de tipo

Para casos simples donde hay pocas variables de tipo involucradas, use una sola letra mayúscula.

  • Coincidir con la expresión regular ^[AZ][0-9]?$
  • Si una letra es más descriptiva que otra (como K y V para claves y valores en mapas o R para un tipo de retorno de función) use eso, de lo contrario use T
  • Para los casos complejos en los que las variables de una sola letra se vuelven confusas, use nombres más largos escritos con mayúsculas y use el guión bajo ( _ ) para separar las palabras.
  • Ejemplos: T , V , SRC_VERTEX

Constantes

Las constantes (campos static final cuyo contenido es inmutable, por reglas de idioma o por convención) deben nombrarse con todas las letras mayúsculas y el subrayado ( _ ) para separar las palabras.

  • Coincidir con la expresión regular ^[AZ][A-Z0-9]*(_[A-Z0-9]+)*$
  • Ejemplos: BUFFER_SIZE , MAX_LEVEL

Otras directrices sobre nombramiento

  • Evite ocultar / sombrear métodos, variables y variables de tipo en ámbitos externos.
  • Deje que la verbosidad del nombre se correlacione con el tamaño del alcance. (Por ejemplo, use nombres descriptivos para campos de clases grandes y nombres breves para variables locales de corta duración).
  • Al nombrar miembros públicos estáticos, deje que el identificador sea auto-descriptivo si cree que serán importados estáticamente.
  • Más información: Sección de nombres (en la guía de estilo de Java oficial)

Fuente: Directrices de estilo de Java de Oracle

Stats

Contributors: 11
2016-08-09
Licenciado bajo: CC-BY-SA

No afiliado a Stack Overflow
Rip Tutorial: info@zzzprojects.com

Descargar eBook