root / trunk / libraries / libCq CMS for java.old / doc-files / GuiaDeEstilo.txt @ 2849
History | View | Annotate | Download (2.03 KB)
1 | 2849 | nacho | Convenciones a seguir en el nombre de los m?todos y variables: |
---|---|---|---|
2 | |||
3 | Nomenclatura: |
||
4 | - Las clases empiezan en may?sculas, los packages, las funciones y los m?todos empiezan en min?sculas. |
||
5 | - Los get/set/is siguen la estructura [set|get|is]CosaQueHaceTipoDeDato |
||
6 | - No usar caracter _ en nombres de variable, m?todo, clase o package. |
||
7 | - Las palabras que componen una variable, m?todo, clase o package van con la inicial en may?scula. |
||
8 | - Los nombres de variable, m?todo, clase o package van en ingl?s. |
||
9 | - Los nombres de los interfaces comenzar?n por 'I' |
||
10 | |||
11 | Espaciado y Tabulaci?n |
||
12 | - Siempre usar tabuladores (no espacios). El tabulador puesto a 4. |
||
13 | - Una l?nea de separaci?n entre el final de una funci?n y el inicio de la siguiente. |
||
14 | - Una l?nea de separaci?n entre las variables de clase y los m?todos. |
||
15 | - Pueden separarse las variables en bloques tem?ticos con una l?nea de separaci?n. |
||
16 | - Alinear las variables de clase con tabuladores. El inicio de cada una debe caer en la |
||
17 | misma vertical. |
||
18 | - Despu?s de una coma de separaci?n de par?metros de una funci?n o llamada a esta |
||
19 | hay que dejar un espacio. |
||
20 | - Detr?s de los finales de bloque se pone una l?nea en blanco |
||
21 | |||
22 | Comentarios |
||
23 | - Estandar de javadoc en las cabeceras de las funciones y clases. Este bloque |
||
24 | ir? pegado a la funci?n que comenta y guardar? una l?nea con la funci?n anterior. |
||
25 | - Comentar bloques tem?ticos de c?digo dentro de las funciones. Usar // con tres |
||
26 | o menos l?neas de c?digo y /**/ con cuatro en adelante. |
||
27 | - Para los imports usar "Source"->"Organize Imports" que queda bien, bien. |
||
28 | |||
29 | Sintaxis general |
||
30 | - Abrir llave detr?s de la instrucci?n (if, funciones, switch, while, etc) |
||
31 | - Forzar a las variables de clase al tipo de atributo de protecci?n adecuado |
||
32 | (private, public, protected) |
||
33 | |||
34 | Pasos a seguir antes de subir al CVS un nuevo fichero de c?digo: |
||
35 | 1- Corregir sangrado. "Source"->"Correct Indentation" |
||
36 | 2- Organizar imports "Source"->"Organize Imports" |
||
37 | 3- Generar comentarios para javadoc en cabeceras de funciones y clases |
||
38 | "Source"->"Add JavaDoc Comment" o Alt+Shift+J estando sobre la funci?n. |