Documentos de Académico
Documentos de Profesional
Documentos de Cultura
Guia N°4 - Convenciones para Las Nomenclaturas
Guia N°4 - Convenciones para Las Nomenclaturas
Convenciones para la
nomenclatura: Normas y
directrices
INTRODUCCIN
En el mundo real, las convenciones de cdigo son importantes para los programadores
para una serie de razones:
80% del coste de vida til de una pieza de software va a mantenimiento. Cualquier
software Apenas se mantiene durante toda su vida por el autor original. Convenciones
Cdigo mejorar la legibilidad del software, permitiendo a los ingenieros de software a
entender nuevo cdigo de forma ms rpida y completamente.
Normas de codificacin permiten a los equipos de programadores a entender ms
fcilmente cada cdigo de los dems y ayudar a errores puntuales. En lugar de
codificar a partir de cero, los miembros del equipo tienen ms posibilidades de
compartir y reutilizar cdigo cuando las convenciones de estilo y comentando entre los
miembros del equipo son los mismos.
CONVENCIONES DE NOMENCLATURAS
Pgina 1
Utilice las descripciones completas para los nombres. Evite el uso de abreviaturas. Por
ejemplo, usar nombres como nombre, apellido, y MiddleInitial en lugar de las
versiones ms cortas fName, lname, y mi.
Evite nombres excesivamente largos (ms de 15 caracteres). Por ejemplo,
setTheLengthField debera acortarse a setLength.
Evite los nombres que son muy similares o difieren slo por si acaso. Por ejemplo,
evitar el uso de los nombres de productos, los productos y los productos en el mismo
programa por temor a mezclarlos.
Justificacin
Usted debe escribir el cdigo con el objetivo de hacer comprensible a los dems. Otros
tendrn que leer y entender el cdigo y una de las principales claves para la comprensin
es a travs de la utilizacin de nombres de identificadores significativos.
Variables:
Elegir nombres significativos que describen para lo que la variable se utiliza. Evite los
nombres genricos como nmero o temp (temporal) cuyo propsito es claro.
Componer nombres de variables usando letras maysculas y minsculas combinadas que
comienzan con una letra minscula (notacin Camell Case). Por ejemplo, utilice
ordenVenta lugar de OrdenVenta u orden_venta.
Utilice nombres en plural para las matrices. Por ejemplo, utilice PuntuacionesPruebas
lugar de PuntuacionPrueba.
Pgina 2
Excepcin: para las variables de control del bucle se nombran a menudo simplemente i, j,
k, declararlo local para el bucle siempre y cuando sea posible.
Declarando y comentando las variables locales
Constantes:
Las constantes se nombran utilizando letras maysculas en todo el nombre de la variable,
utilizando un guion bajo en las palabras compuestas. Por ejemplo:
La
constante
Temperatura
TEMPERATURA_MAXIMA
mxima
se
puede
representar
as:
Evite el uso de nmeros mgicos en el cdigo. Nmeros mgicos son nmeros reales como
27 que aparecen en el cdigo que requiere el lector de averiguar lo que 27 se est
utilizando para. Considere el uso de constantes con nombre para cualquier nmero distinto
de 0 y 1.
Justificacin:
Mediante el uso de todo en maysculas para sus constantes con nombre, otros leyendo su
cdigo sabrn inmediatamente que el identificador es un valor constante fijo que no se
puede cambiar.
El uso de nombres significativos para las constantes en lugar de utilizar nmeros mgicos
en el cdigo hace que el cdigo auto-documentado, lo que reduce la necesidad de los
comentarios finales. Por ejemplo, mira a las dos lneas de cdigo a continuacin y
determinar por s mismo que el uso de constantes con nombre hace segunda lnea de
cdigo auto-documentado y ms legible.
Ejemplo 1:
for (int i = 0; i < TEMPERATURA_MAXIMA; i++)
{
Temperatura = Temperatura + 1;
Pgina 3
}
Ejemplo 2
dia = (3 + numeroDeDias) % 7; //No usar nmeros mgicos!
final int MIERCOLES = 3;
final int DIAS_EN_SEMANA = 7
dia = (MIERCOLES + numeroDeDias) % DIAS_EN_SEMANA; //Este si, se entiende por s
sola
Justification
Estas convenciones son una prctica comn en la comunidad de desarrollo de Java, as
como la convencin de nombres para las variables utilizadas por Sun Microsistems
(adquirida por Oracle en 2010) para los paquetes principales de Java. Escribir cdigo que
sigue a estas convenciones hace que las variables sean fcil de distinguir para otros.
CONVENCIONES PARA NOMBRAR MTODOS (FUNCIONES)
Trate de llegar a los nombres de mtodos significativas que describen de manera sucinta el
propsito del mtodo, por lo que su cdigo de auto-documentado y reduciendo la
necesidad de comentarios adicionales.
Pgina 4
Justificacin:
Estas convenciones son una prctica comn en la comunidad de desarrollo de Java, as
como la convencin de nombres para los mtodos utilizados por Oracle para los paquetes
principales de Java. Escribir cdigo que sigue a estas convenciones hace que los mtodos
fciles para que otros lo identifican en el cdigo. A pesar de que las variables y los
mtodos de ambos comienzan con una letra minscula seguida de maysculas y
minsculas, que fcilmente pueden ser diferenciados unos de otros porque los nombres de
mtodos comienzan con un verbo y se siguen inmediatamente con un conjunto de
parntesis , por ejemplo : moverCuenta().
Los comentarios proporcionan a los lectores con la informacin til para la comprensin de
su programa.
Pgina 5
Utilice los comentarios para proporcionar una visin general o resmenes de los trozos de
cdigo y proporcionar informacin adicional que no est fcilmente disponible en el propio
cdigo.
Comentario de los detalles de las decisiones de diseo obvias no triviales o no; evitar los
comentarios que se limita a reiterar la informacin que est presente y claro en la lectura
del cdigo.
Se utilizarn tres tipos de comentarios:
************************************************ **********
Asignacin: Programa 2
Cuenta : (Ingrese su nmero de cuenta aqu)
Autor : ( Escriba su nombre completo aqu)
Tiempo de ejecucin :( Escriba el nmero total de horas que
Gastado en la asignacin )
Cdigo de Honor : Prometo que este programa representa mi propia
Cdigo del programa. Recib ayuda de ( escriba los nombres de
Otros que ayudaron con la asignacin , escriben nadie si
Recibi ninguna ayuda) en el diseo y la depuracin de mi programa.
Pgina 6
// ************************************************ *********
Uso de comentarios en una sola lnea
Utilice los comentarios de una sola lnea, tambin llamados comentarios en lnea, para
proporcionar breves comentarios de resumen para trozos de cdigo.
Proceda comentarios de una sola lnea con una lnea en blanco y alinear el comentario con
el cdigo resume. No sienta la necesidad de comentar cada lnea de cdigo, en lugar
resumir trozos de cdigo entre 3 a 7 lneas de longitud.
Comience comentarios de una lnea con una doble barra (//) que le dice al compilador que
ignorar el resto de la lnea. Nota: no coloque ningn carcter entre las dos barras.
Justificacin:
Al separar trozos de cdigo por lneas en blanco y procediendo cada una con un
comentario explicativo, los lectores (y usted mismo) pueden identificar rpidamente y
comprender secciones de cdigo en la que se llevan a cabo acciones especficas.
Siempre agregar comentarios mientras usted est codificando en lugar de esperar hasta
que se termine el programa. Los resmenes y las razones sern fresca y precisa en lugar
de lugar- rellenos que no ofrecen ningn valor real.
Ejemplo
//Calcular la puntuacin media del examen para el examen de mitad de perodo
sumaDePuntajes = 0 ;
for ( int i = 0; i < puntajes.length ;i ++ )
{
sumaDePuntajes = sumaDePuntajes + resultados [ i ];
}
Media = float ( sumaDePuntajes ) / puntajes.length ;
Arrastrando Comentarios
Comentarios lnea por lnea se utilizan para proporcionar una explicacin para una sola
lnea de cdigo. Comience comentarios finales con una doble barra ( // ) y colocarlos a la
derecha de la lnea de cdigo que hacen referencia.
Comentarios finales se utilizan para explicar cdigo complicado, especifique lo abrevian los
nombres de variables se refieren a, o de otra manera aclaran lneas poco claras de cdigo.
En general, evite el uso de comentarios finales. En lugar reescribir cdigo complicado o
poco clara, utilizar nombres de variables significativas, y se esfuerzan por cdigo autodocumentado.
Pgina 7
Justificacin
Los comentarios finales se utilizaban a los das de programacin en lenguaje ensamblador
donde eran imposibles de entender sin el uso de los comentarios de las lneas individuales
de cdigo.
Lenguajes de programacin modernos como Java permiten a los programadores escribir
cdigo auto-documentado el uso de nombres de variables significativas, lo que elimina la
necesidad de que los comentarios finales.
ss = s1 + s2 + s3 ; // aadir las tres puntuaciones en la suma
a = float ( ss) / x ; // calcular la media de las puntuaciones
Nota:
Este es un ejemplo de la manera EQUIVOCADA de comentar un programa
FORMATO DEL CODIGO
... {
...... System.out.print ("bueno");
...... if ( horaActual < Tarde )
...... {
......... System.out.println ("Maana");
...... }
...... else if (horaActual < Tarde)
...... {
......... System.out.println ("Tarde");
...... }
...... else
...... {
......... System.out.println("Noche");
...... }
...}
}
Nota: El carcter . Denota la identacin
Espacios en blanco
Use lneas en blanco y los espacios en blanco para mejorar la legibilidad del cdigo.
Use lneas en blanco para separar trozos de cdigo del programa. Trozos son grupos
lgicos de sentencias de programa (generalmente 3 a 7 lneas de longitud) y por lo general
procedido con un resumen comentario de una sola lnea. Utilice una lnea en blanco antes
de cada trozo programa. Use dos lneas en blanco antes del inicio de cada nuevo mtodo
dentro de una clase.
Utilice un espacio en blanco en ambos lados de smbolos de operador, despus de las
comas en las listas de argumentos, y despus de un punto y coma en las declaraciones.
Lneas y espacios en blanco permiten al programador para mostrar prrafos u organizacin
del cdigo en pequeas agrupaciones, lgicas para mejorar la legibilidad. Mira las dos
ejemplos a continuacin y observe cunto ms legible se compara el ejemplo inferior al
ejemplo superior sin lneas en blanco y espaciado.
Ejemplo:
Fragmento de cdigo sin espacios
// Pide al usuario que introduzca el tipo de comisin
SimpleIO.prompt( " Ingrese el tipo de comisin (en porcentaje ) :");
entradaUsuario=SimpleIO.readLine ();
doble tasaComision=Double.parseDouble ( entradaUsuario )/100;
// Calcular y mostrar la comisin, el redondeo al cntimo ms cercano
doble comision=valorTotal*tasaComision;
comision=Math.round(comision*100)/100.0 ;
System.out.println ("Comisin : $" + comision) ;
Nota: Esta es la forma no deseada
FRAGMENTO DE CDIGO CON ESPACIOS
// PIDE AL USUARIO QUE INTRODUZCA EL TIPO DE COMISIN
Pgina 9
Longitud de lnea
Evite las lneas de ms de 80 caracteres. Cuando una expresin no cabe en una sola lnea
de 80 caracteres, romperlo acuerdo con estos principios generales:
Ejemplo:
Referencias
Pgina 10