Uso de convenciones de nomenclatura Java

Una convención de nomenclatura es una regla a seguir a medida que decide cómo nombrar sus identificadores (por ejemplo, clase, paquete, variable, método, etc.).

Por qué usar convenciones de nomenclatura?

Los diferentes programadores de Java pueden tener diferentes estilos y enfoques para la forma en que programan. Al usar las convenciones de nomenclatura estándar de Java, hacen que su código sea más fácil de leer para ellos y para otros programadores. La legibilidad del código Java es importante porque significa que se dedica menos tiempo a tratar de averiguar qué hace el código, dejando más tiempo para arreglarlo o modificarlo..

Para ilustrar el punto, vale la pena mencionar que la mayoría de las compañías de software tendrán un documento que describe las convenciones de nomenclatura que desean que sigan sus programadores. Un nuevo programador que se familiarice con esas reglas podrá comprender el código escrito por un programador que podría haber abandonado la compañía muchos años antes..

Elegir un nombre para su identificador

Al elegir un nombre para un identificador, asegúrese de que sea significativo. Por ejemplo, si su programa trata con cuentas de clientes, elija nombres que tengan sentido para tratar con clientes y sus cuentas (por ejemplo, customerName, accountDetails). No te preocupes por la longitud del nombre. Un nombre más largo que resume perfectamente el identificador es preferible a un nombre más corto que puede ser rápido de escribir pero ambiguo.

Algunas palabras sobre casos

Usar la letra mayúscula correcta es la clave para seguir una convención de nomenclatura:

• En minúscula es donde todas las letras de una palabra se escriben sin mayúsculas (p. ej., while, if, mypackage).
• Mayúscula es donde todas las letras de una palabra se escriben en mayúsculas. Cuando hay más de dos palabras en el nombre, use guiones bajos para separarlos (por ejemplo, MAX_HOURS, FIRST_DAY_OF_WEEK).
• El caso de Carmel (también conocido como Upper CamelCase) es donde cada palabra nueva comienza con una letra mayúscula (por ejemplo, CamelCase, CustomerAccount, PlayingCard).
• Caso mixto (también conocido como Lower CamelCase) es lo mismo que CamelCase, excepto que la primera letra del nombre está en minúscula (por ejemplo, hasChildren, customerFirstName, customerLastName).

Convenciones de nomenclatura estándar de Java

La siguiente lista describe las convenciones de nomenclatura estándar de Java para cada tipo de identificador:

• Paquetes: Los nombres deben estar en minúsculas. Con proyectos pequeños que solo tienen unos pocos paquetes, está bien solo darles nombres simples (¡pero significativos!):

   paquete pokeranalyzer paquete mycalculator 

  En compañías de software y proyectos grandes donde los paquetes pueden importarse a otras clases, los nombres normalmente se subdividirán. Normalmente, esto comenzará con el dominio de la empresa antes de dividirse en capas o características:

   package com.mycompany.utilities package org.bobscompany.application.userinterface 

• Clases Los nombres deben estar en CamelCase. Intenta usar sustantivos porque una clase normalmente representa algo en el mundo real:

   clase Clase de cliente Cuenta 

• Interfaces: Los nombres deben estar en CamelCase. Tienden a tener un nombre que describe una operación que una clase puede hacer:

   interfaz Interfaz comparable Enumerable 

  Tenga en cuenta que a algunos programadores les gusta distinguir las interfaces comenzando el nombre con una "I":

   interfaz IComparable interfaz IEnumerable 

• Métodos: Los nombres deben estar en mayúsculas y minúsculas. Use verbos para describir lo que hace el método:

   void CalculateTax () string getSurname () 

• Variables: Los nombres deben estar en mayúsculas y minúsculas. Los nombres deben representar lo que representa el valor de la variable:

   string firstName int orderNumber 

  Utilice solo nombres muy cortos cuando las variables son de corta duración, como en for for loops:

   para (int i = 0; i<20;i++)    //i only lives in here  

• Constantes: Los nombres deben estar en mayúscula.

   static final int DEFAULT_WIDTH static final int MAX_HEIGHT