Java estándares de codificación

normas y convenciones de los lenguajes de programación como Java codificación están diseñados para mejorar la calidad y la fiabilidad de las aplicaciones creadas usando esos idiomas. proyectos de Java son a menudo grandes, con componentes que varían trabajados por un número de diferentes desarrolladores. Tener un conjunto compartido de prácticas significa que los desarrolladores pueden trabajar con el código de todo el mundo de manera más eficaz, ya que el código es más clara y fácil de leer.

Naming

convenciones de Java dictan ciertas reglas para asignar nombres a los elementos del programa, tales como variables, clases, objetos, paquetes y las interfaces entre otros. CamelCase se utiliza en la mayoría de los casos como en los siguientes ejemplos:

// Clase nombres empiezan mayúsculas

clase MiClase

// Las variables comienzan minúsculas

Objeto unObjeto

En general, utilice nombres significativos, por ejemplo, "contador" en lugar de "c" para que las personas (incluido usted) para leer su código pueden entender más fácilmente.

Sangrar

La sangría es uno de los elementos clave en la programación que hace que el código más fácil de leer. La sangría debe reflejar, en principio las estructuras lógicas en un programa, y ​​ayuda a identificar la información de un vistazo; Por ejemplo, el alcance de las variables. convenciones de Java también dictan donde se rompe deben ocurrir dentro de las líneas ajustadas de código, con los saltos de línea preferidos se producen después de las comas y antes de los operadores, de la siguiente manera:

aMethod (parameterOne, parameterTwo,

parameterThree);

int = respuesta itemOne + itemTwo

itemThree;

Las segundas líneas en estos casos lo ideal es que venga después de ocho espacios.

comentarios

El uso de los comentarios hace todo el código más fácil trabajar con, en particular si los algoritmos largos o complejos están involucrados. Los comentarios del código de acuerdo con las convenciones de Java deben incluirse antes de las declaraciones de variables clave, los métodos, las clases y las estructuras largas, así como dentro de todos estos. Use las dos observaciones individuales y múltiples líneas, que se producen en sus propias líneas o al final de las líneas de código:

/ *

Este es un comentario en un bloque

* /

// Esta es una sola línea de comentario

int contador = 0; // Esta es una información adicional acerca de la línea de código

Documentación

Se crea la documentación de Java principalmente mediante el uso de las instalaciones de Javadoc, que genera los documentos HTML mayoría de los recursos y aplicaciones Java estándar utilizan, entre ellos el propio lenguaje. Crear contenido Javadoc en el código fuente utilizando los comentarios Javadoc:

/ **

Este es un comentario Javadoc

tenga en cuenta el doble asterisco para comenzar

* /

Cuando los desarrolladores están trabajando con el código que fue desarrollado por otra persona, su primer punto de referencia es a menudo el Javadoc, ya que proporciona una visión general del recurso sin tener que leer realmente el propio código.

Diseño de programa

Hay muchas convenciones y estándares para los detalles de implementación dentro de los programas de Java. Un ejemplo de ello es el enfoque para proporcionar acceso a las variables en una clase de código externo. (Ver Referencias 4) En general, se recomienda mantener las variables de clase privada, y proporcionar acceso a ellos utilizando métodos públicos. Por ejemplo, si una clase tiene una variable de instancia cadena de texto llamado "somedata" podría tener un método que proporciona acceso a la misma desde la aplicación en otra parte:

cadena pública getData () {return somedata; }