¿Cuáles son algunas buenas convenciones de nomenclatura al utilizar Java como lenguaje de programación?

Nombres de paquetes

Los nombres de los paquetes deben consistir enteramente en palabras en minúsculas.

Denominación de clases

El nombre de una clase debe estar formado por palabras que comiencen con una letra mayúscula y el resto de letras en minúscula

Denominación de variables de clase

Los nombres de las variables deben comenzar con una letra minúscula. Las siguientes palabras deben comenzar con letra mayúscula.

Denominación de variables finales estáticas

Los nombres de las variables finales estáticas deben estar en mayúsculas e indicar su significado completo.

Nombramiento de parámetros

Los nombres de los parámetros deben ser consistentes con la convención de nomenclatura de variables.

Nombramiento de matrices

Las matrices siempre deben nombrarse de la siguiente manera:

byte[]?buffer;

En lugar de:

p>

byte?buffer[];

Parámetros del método

Utilice nombres de parámetros significativos y, si es posible, utilice el mismo nombre que el campo que se va a se le asignó un valor:

p>

SetCounter(int?size){

this.size?=?size;

}

Nombre de variable

Al nombrar variables ordinarias, la primera letra debe estar en minúscula y las demás letras deben estar en mayúscula.

El nombre final de la variable estática debe estar en letras mayúsculas y se debe indicar el significado completo. Si un nombre constante consta de varias palabras, se deben utilizar guiones bajos para separar las palabras, por ejemplo

NUM_DAYS_IN_WEEK MAX_VALU

Si necesita abreviar nombres de variables, asegúrese de tener en cuenta que el las reglas de abreviatura son consistentes en todo el código

context=ctx message=msg

Al colocar un cuantificador al final del término,

Primero (el primero en un conjunto de variables) Last (un último en un grupo de variables) Next (Siguiente en un grupo de variables) Prev (Anterior en un grupo de variables) Cur (Variable actual en un grupo de variables)

Cuando sea posible, se recomienda utilizar constantes en lugar de números y cadenas fijas. En otras palabras, no debe haber más números que 0 y 1 en el programa. Variables de índice: i, j, k, etc. solo se utilizan como variables de índice de bucle para bucles pequeños.

Variables lógicas: Evite el uso de banderas para nombrar variables de estado y utilícelas para nombrar variables lógicas.

if(isClosed){ ​​​​dosomeworks; return }

Array

Defina siempre una matriz usando:

int[] arr = new int[10];

C está prohibido:

int arr [] = new int[10];

Colección

Int arr [] = new int[10];

Colección

p>

La convención de nomenclatura recomendada para matrices o contenedores es sustantivo + s, por ejemplo :

Lista?personas = getPerson(); for(Persona persona: personas){ dosomeworks }

Panotipos

Deben ser lo más concisos posible (preferiblemente usando una letra) para ayudar a distinguirlos de las clases o interfaces ordinarias

Los elementos en los contenedores deben representarse mediante E; las claves en Maps usan K para representar, el valor para usar V para representar, el tipo para usar T para representar; X para representar, por supuesto, también puedes usar letras como T1 y T2

clase pública HashSet?extends AbstractSet?{...} clase pública HashMapextends AbstractMap?{...} clase pública ThreadLocal?{. ..} interfaz pública Functor?{ T val() lanza Abreviaturas (no recomendado)

cp significa colorPoint buf significa buffer off significa offset len ​​​​significa longitud

Generalmente no se recomienda usar una sola letra como nombre de variable a menos que está en un bucle, pero hay excepciones, es decir, se acostumbra utilizar una sola letra

b representa el byte, c representa el carácter d, representa el doble byte

ContainerTest

ContainerTest

ContainerTest

Nombre la clase de finalización con "Prueba". para char d para doble e para excepción f para float i, j, k para entero l para long o para Object s para String v para algunos tipos específicos de valores

Estilo de código

Curar llaves

El formato de uso unificado de las llaves es el siguiente:

if( bool experssion){ dosomework }

Curar llaves no se puede usar bajo ningún; circunstancias Omitido, a menos que esté vacío y deba estar en un carácter de nueva línea, por ejemplo

if(i==0){ return } while(true) {}

Lo siguiente está prohibido escribir de:

Prohibido if(i ! = 0) return; prohibido if(i ! = 0) {return;}

Paréntesis

Paréntesis tiene un no antes y después de Caracteres con espacios, por ejemplo:

Persona p = nueva Persona("Jack", 17);

Espacios

Una coma va seguida de un espacio.

Persona p = new Person("Jack", 16, "China");

Los operadores binarios van seguidos de un espacio.

int i = a + b - c * d;

3. Los operadores unarios no requieren espacios y la declaración for tiene espacios después del punto y coma.

for(int i = 0; I < 10; i++){ dosomework }

4. No dejes espacios antes y después de los corchetes

Clase<. /p>

La estructura de la definición de clase es la siguiente:

1) Constantes

2) Variables miembro

3) Constructores

4) Funciones miembro

5) Obtener y establecer métodos

Una línea en blanco entre cada parte.

Ejemplo:

Plantilla de clase canónica:

clase Persona{ private final static int MAX_AGE = 100 private String firstname = "Jack" public Person(); {} persona pública (nombre de cadena) { this.public doExercise(){ dosomeworks; run(); } ejecución privada void() { dosomeworks } public getFirstname(){ return nombre} público setFirstname (nombre de cadena){ this. firstname = firstname; }

2.｝}

2. Constructor

1) El constructor con parámetros vacíos está en la parte superior

2) Los constructores con relaciones de llamada son adyacentes

3) Organice los parámetros en orden descendente

3 Utilice los métodos get y set para acceder a las variables miembro.

4. Métodos

Los métodos que tienen una relación de llamada deben colocarse lo más cerca posible, y los métodos públicos y privados se pueden colocar de forma cruzada.

5. Métodos de obtención y configuración. Todas las variables miembro que deben exponerse deben cumplir con buenas especificaciones de Javabean, proporcionar métodos de obtención y configuración e intentar utilizar herramientas IDE para generarlas automáticamente.

Comentarios de Javadoc

Al comienzo de cada programa, los comentarios de Javadoc se utilizan generalmente para dar una descripción general del programa y explicar la información de derechos de autor. Luego, en el programa principal, cada clase. , Agregue comentarios de Javadoc a interfaces, métodos y campos. Al comienzo de cada comentario, use una oración para resumir las funciones que deben completar la clase, la interfaz, el método y el campo. Esta oración debe estar en una línea separada para enfatizar. la generalidad, y se pueden agregar más detalles más adelante. El párrafo descriptivo puede ir seguido de un párrafo especial que comience con una etiqueta de comentario Javadoc, como @auther y @version en el ejemplo anterior, que aparecerá de forma específica en la documentación generada.