convenciones de Java dictan determinadas normas para nombrar 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 :
//Nombres Genéricos iniciar mayúsculas
clase MyClass
//Variables comienzan minúsculas
objeto unObjeto
En general , utilice nombres significativos , por ejemplo, " counter" en lugar de " c" para que las personas (incluido usted ) para leer su código pueden entender más fácilmente.
sangría
sangría es uno de los elementos clave de programación que hace el código más fácil de leer . La sangría debe generalmente reflejan 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 que rompe deben ocurrir dentro de las líneas ajustadas de código, los saltos de línea preferentes que ocurran después de las comas y antes de que los operadores de la siguiente manera :
aMethod ( parameterOne , parameterTwo ,
parameterThree ) ;
int respuesta = itemOne + itemTwo
itemThree ; .
Los segundas líneas en estos casos lo ideal sería llegar a los ocho espacios
comentarios
El uso de los comentarios que hace todo el código más fácil de trabajar, sobre todo si los algoritmos largos o complejos están involucrados. Los comentarios de código de acuerdo con convenciones de Java deben ser incluidos antes de 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 varias líneas , que se producen en sus propias líneas o al final de las líneas de código :
/* por
* Este es un comentario en un bloque
* /foto
//Esto es una sola línea de comentario
int contador = 0 ; //se trata de obtener información adicional acerca de la línea de código
Documentación
crear documentación de Java principalmente mediante el uso de las instalaciones de Javadoc , que genera los documentos HTML recursos de Java más estándar y el uso de aplicaciones, incluyendo la propia lengua. Crear contenido Javadoc del código fuente mediante comentarios Javadoc :
/**
* Este es un comentario Javadoc
* - anote el doble asterisco para comenzar
< p> * /foto
Cuando los desarrolladores están trabajando con código desarrollado por alguien más, su primer punto de referencia suele ser el Javadoc , ya que proporciona una visión general de los recursos sin tener que leer realmente el propio código.
Program Design
Hay muchas convenciones y normas para los detalles de implementación dentro de los programas de Java . Un ejemplo de ello es el enfoque de proporcionar acceso a las variables de una clase de código externo . (Ver Referencias 4 ) Generalmente se recomienda mantener las variables de clase privada y facilitar el acceso a ellos utilizando métodos públicos. Por ejemplo, si una clase tiene una cadena de texto variable de instancia denominada " somedata " podría tener un método de proporcionar acceso a la misma desde la aplicación en otro lugar :
public string getData () {return somedata ;}