gerardo
07120753
Instituto Tecnológico de Morelia
Ingeniería en Sistemas Computacionales
Estándares de
Codificación
Materia: Reestructuración de Código
Profesor: Salvador Jonathan Villagómez Cárdenas
Alumno: Gerardo Orozco Mosqueda
No. Control: 07120753
Descripción: Investigación acerca de los estándares de codificación y las notaciones
‘Húngara’ y ‘Camello’.Página 1 de 10
Gerardo Orozco Mosqueda
CONTENIDO
ESTÁNDARES DE CODIFICACIÓN
INTRODUCCIÓN
CONVENCIONES DE CODIGO
ARCHIVOS
SUFIJOS
NOMBRES DE ARCHIVO
ORGANIZACIÓN
INDENTACION
LONGITUD DE LINEAS
SALTOS DE LINEA
COMENTARIOS
IMPLEMENTACION
COMENTARIOS DE BLOQUE
COMENTARIOS DE UNA LINEA
DOCUMENTACION
DECLARACIONES
CANTIDAD
INICIALIZACION
UBICACIÓN
CLASES E INTERFACESSENTENCIAS
DE RETORNO
IF, IF ELSE
ESPACIOS EN BLANCO
LINEAS EN BLANCO
ESPACIOS EN BLANCO
CONVENCIONES DE NOMBRES
CLASES E INTERFACES
METODOS
VARIABLES
CONSTANTES
CONTROL DE VERSIONES
APORTES PARA DESARROLLADORES
NOTACIÓN HÚNGARA
CONTRAS
EJEMPLOS DE NOTACIONES DE 1 CARACTER
NOTACIÓN DE CAMELLO
UpperCamelCase
lowerCamelCase
REFERENCIAS
Página 2 de 10
07120753Gerardo Orozco Mosqueda
07120753
ESTÁNDARES DE CODIFICACIÓN
INTRODUCCIÓN
Al programar en un leguaje en específico se deben seguir reglas que permitirán que
cualquier persona que se desempeñe como codificador de dicho lenguaje, pueda interpretar de
manera eficiente la escritura del código.
Este documento describe las reglas de codificación estandar para programación con Java.CONVENCIONES DE CODIGO
Las convenciones de codificacion son importantes por diversas razones:
● 80% del costo del tiempo de visa del software reside en el mantenimiento.
● Es muy dificil que el software sea mantenido por el autor original.
● Las convenciones mejoran la legibilidad del código, permitiendo que los ingenieros
entiendan código nuevo con mayor rapidez.
ARCHIVOSSUFIJOS
Java usa los siguientes sufijos:
●
●
●
Los archivos de código fuente tienen extensión .j v .
aa
Los archivos binarios tienen extension .c a s
ls
Los archivos
NOMBRES DE ARCHIVO
Se usan en UpperCamelCase. Por ejemplo:
● Productos.java
● CuentaCliente.java
● CuentaProveedor.java
ORGANIZACIÓN
En la organización de archivos hay que tener en cuenta tres aspectos:
1.Comentarios de inicio. Información básica de la clase, su versión, etc.
2. Sentencias p c a ee i p r . La primera es p c a ey es seguida de los i p r s
akg
mot
akg
mot
necesarios.
3. Declaraciones de clases e interfaces. Se establece las partes y el orden como deben
Página 3 de 10
Gerardo Orozco Mosqueda
07120753
ser descritas.
INDENTACION
Significa mover un bloque de textos a la derecha usando espacios en blanco con el fin de
mejorar la legibilidad del código fuente. Se recomienda usar cuatro espacios por bloque.
LONGITUD DE LINEAS
Con el fin de evitar errores en la comprension por parte de algunas consolas o programaas, se
sugiere que las líneas de código no excedan los 80 caracteres.Para documentación se recomiendan líneas más cortas, de 70 caracteres.
SALTOS DE LINEA
Ocurren cuando para una expresión no es suficiente una sola linea, con lo cual se continua en
la siguiente línea, tratando de no romper la legibilidad.
COMENTARIOS
Existen dos tipos de comentarios: de implementación y de documentación.
IMPLEMENTACION
Usados para comentar el código o una implementación especifica.COMENTARIOS DE BLOQUE
Se usan al inicio de cada archivo o dentro de los métodos con el fin de dar una breve
explicación del mismo. Se incluyen dentro de los caracteres / y * .
* /
COMENTARIOS DE UNA LINEA
Son comentarios cortos a nivel de una linea que sigue. Se incluyen a continuación de los
caracteres / .
/
DOCUMENTACION
Usados para describir ...
Regístrate para leer el documento completo.