Revision 1767

View differences:

branches/CqCMSDvp/libraries/libCq CMS for java.old/doc-files/GuiaDeEstilo.txt
1 1 
Convenciones a seguir en el nombre de los m?todos y variables:
2 

  		




  
  3
  
    
Nomenclatura:


  		




  2
  4
  
    
	- Las clases empiezan en may?sculas, los packages, las funciones y los m?todos empiezan en min?sculas.


  		




  3
  5
  
    
	- los get/set/is siguen la estructura [set|get|is]CosaQueHaceTipoDeDato


  		




  4
  
  
    
	- Siempre usar tabuladores (no espacios). El tabulador puesto a 4


  		




  5
  
  
    
	- Abrir llave detr?s de la instrucci?n (if, funciones, switch, while, etc)


  		




  6
  6
  
    
	- No usar caracter _ en nombres de variable, m?todo, clase o package.


  		




  7
  7
  
    
	- Las palabras que componen una variable, m?todo, clase o package van con la inicial en may?scula.


  		




  8
  8
  
    
	- los nombres de variable, m?todo, clase o package van en ingl?s.


  		




  9
  
  
    
	- los interfaces empiezan por I


  		




  10
  
  
    
	- entre el comentario javadoc de un m?todo o clase y el m?todo o clase NO va linea en blanco


  		




  11
  
  
    
	- entre funciones va una linea en blanco


  		




  12
  
  
    
	- detras de los finales de bloque va linea en blanco solo si hay c?digo.


  		




  
  9
  
    
		


  		




  
  10
  
    
Espaciado y Tabulaci?n


  		




  
  11
  
    
	- Siempre usar tabuladores (no espacios). El tabulador puesto a 4.


  		




  
  12
  
    
	- Una l?nea de separaci?n entre el final de una funci?n y el inicio de la siguiente.


  		




  
  13
  
    
	- Una l?nea de separaci?n entre las variables de clase y los m?todos.


  		




  
  14
  
    
	- Pueden separarse las variables en bloques tem?ticos con una l?nea de separaci?n.


  		




  
  15
  
    
	- Alinear las variables de clase con tabuladores. El inicio de cada una debe caer en la


  		




  
  16
  
    
	misma vertical.


  		




  
  17
  
    
	- Despu?s de una coma de separaci?n de par?metros de una funci?n o llamada a esta


  		




  
  18
  
    
	hay que dejar un espacio. 


  		




  
  19
  
    
	


  		




  
  20
  
    
Comentarios


  		




  
  21
  
    
	- Estandar de javadoc en las cabeceras de las funciones y clases. Este bloque 


  		




  
  22
  
    
	ir? pegado a la funci?n que comenta y guardar? una l?nea con la funci?n anterior.


  		




  
  23
  
    
	- Comentar bloques tem?ticos de c?digo dentro de las funciones. Usar // 


  		




  
  24
  
    
	- Para los imports usar "Source"->"Organize Imports" que queda bien, bien.


  		




  
  25
  
    

  		




  
  26
  
    
Sintaxis general


  		




  
  27
  
    
	- Abrir llave detr?s de la instrucci?n (if, funciones, switch, while, etc)


  		




  
  28
  
    
	- Forzar a las variables de clase al tipo de atributo de protecci?n adecuado 


  		




  
  29
  
    
	(private, public, protected)


  		




  
  30
  
    
		


  		




  
  31
  
    
	


  		












Also available in:  Unified diff