Las convenciones de código son importantes para los programadores por muchas razones:

• El 80% del coste del código de un programa va a su mantenimiento.
• Casi ningún software lo mantiene toda su vida el auto original.
• Las convenciones de código mejoran la lectura del software, permitiendo entender código nuevo mucho más rápidamente y más a fondo.
• Si distribuye su código fuente como un producto, necesita asegurarse de que está bien hecho y presentado como cualquier otro producto.

Para que funcionen las convenciones, cada persona que escribe software debe seguir la convención. Todos.

Algunos aspectos a documentar son los siguientes:

• Nombres de archivo
• Organización de los archivos
• Indentación
• Comentarios
• Declaraciones
• Sentencias
• Espacio en blanco
• Convenciones de nomenclatura

Nombres de archivo.

Esta sección enumera las extensiones y los nombres de archivo más usados .

Organización de los archivos.
Un archivo está formado por secciones que deben estar separadas por líneas en blanco y comentarios opcionales que identifican cada sección. Se deberá evitar la creación de archivos de más de 2000 líneas puesto que son incómodos de manejar. Los archivos fuente tienen la siguiente ordenación:

• Comentarios de inicio
• Sentencias «package» e «import»
• Declaraciones de clases e interfaces

 
Indentación
Se deben emplear cuatro espacios como unidad de indentación. La construcción exacta de la indentación (espacios en blanco o tabuladores) no se especifica. Los tabuladores deben ser exactamente cada 8 espacios (no 4).

Comentarios.
Los programas realizados pueden tener dos tipos de comentarios: comentarios de implementación y comentarios de documentación. Los comentarios de implementación son aquellos que también se encuentran en C++, delimitados por /*…*/, y //. Los comentarios de documentación (conocidos como «doc comments») existen sólo en Java, y se limitan por /**…*/.

Declaraciones

Se recomienda una declaración por línea, ya que facilita los comentarios.

Nota: Los ejemplos anteriores usan un espacio entre el tipo y el identificador. Una alternativa aceptable es usar tabuladores, por ejemplo

Al programar clases e interfaces, se siguen las siguientes reglas de formato:

• Ningún espacio en blanco entre el nombre de un método y el paréntesis «(» que abre su lista de parámetros
• La llave de apertura «{» aparece al final de la misma línea de la sentencia de declaración
• La llave de cierre «}» empieza una nueva línea indentada ajustada a su sentencia de apertura correspondiente, excepto cuando no existen sentencias entre ambas, que debe aparecer inmediatamente después de la de apertura «{»

Sentencias

Cada línea debe contener como máximo una sentencia. Ejemplo:

La clase de sentencias if-else debe tener la siguiente forma:

Espacio en blanco

Las líneas en blanco mejoran la facilidad de lectura separando secciones de código que están lógicamente relacionadas. Se deben usar siempre dos líneas en blanco en las siguientes circunstancias:

• Entre las secciones de un archivo fuente
• Entre las definiciones de clases e interfaces

Se debe usar siempre una línea en blanco en las siguientes circunstancias

• Entre métodos
• Entre las variables locales de un método y su primera sentencia
• Antes de un comentario de bloque o de un comentario de una línea

Todos los operadores binarios excepto «.» se deben separar de sus operandos con espacios en blanco. Los espacios en blanco no deben separar los operadores unarios, incremento («++») y decremento («–») de sus operandos. Ejemplo:

Convenciones de nomenclatura 

Las convenciones de nomenclatura hacen que el código sea más inteligible al hacerlo más fácil de leer. También pueden dar información sobre la función de un identificador, por ejemplo, cuando es una constante, un paquete o una clase, lo cual puede ser útil para entender el código