Recomendaciones para la escritura de código fuente en lenguaje Java

Recomendaciones para la escritura de código fuente en lenguaje Java:

     Las convenciones para codificación son recomendaciones que se establecen con el fin de fijar un estándar que sea fácil y ameno para distintos programadores, de modo que se agilice la comprensión del código fuente y en su caso el programar haciendo uso de este asimilando fácilmente nombres y significados de clases y métodos.

• Clases: Los nombres de clases sean sustantivos, con mayúsculas y minúsculas, con la primera letra de cada palabra en mayúsculas.

class Persona

• Interfaces: Los nombres de interfaces sean como los de las clases.

interface Volador

• Métodos: Los nombres de métodos sean verbos, con mayúsculas y minúsculas, con la primera letra en minúsculas y separar cada palabra después de la primera, con mayúsculas la primera letra. Evitar el uso del guión bajo.

dameNombre()

• Variables: Los nombres de variables con mayúsculas y minúsculas, con la primera letra en minúsculas y separar cada palabra después de la primera, con mayúsculas la primera letra. Evitar el uso del guión bajo y del signo de $, este último ya que tiene un significado especial para las clases internas. Estas variables deberían mostrar su significado a la vista de modo que indiquen la intención de su uso.

contadorVehiculos

• Constantes: Las constantes de tipos de datos primitivos sean todas mayúsculas, cuyas palabras estén separadas por guión bajo. Sin embargo, las constantes de objetos pueden escribirse como las variables.

KILOBYTE

MAX_DATOS

• Estructuras de control: Usar llaves para contener sentencias aun que se trate de una sola sentencia, cuando estas se encuentren en una estructura de control como if-else y for.

if (condición) {

   hacer algo;

}

else {

   hacer otra cosa;

}

• Espaciado (indentación): Escribir una sola sentencia por línea y usar de dos a cuatro espacios de indentación para hacer el código legible.
• Comentarios: utilizar // para comentarios de una sola línea, /*...*/ para comentarios que requieran de múltiples líneas y /**...*/ para documentación a generar por javadoc en forma de HTML.

Referencias:

Java Programming Language (SL-275), Sun microsystems, revision D April 2000, págs. 3-35 a 3-37

[referencia en el formato de página web: Module 3 - Identifiers, Keywords, and Types  (31,32 of 36)]

Nota: Para más información, consultar la página web:

http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html

...