Estandares de codificacion

Solo disponible en BuenasTareas
  • Páginas : 7 (1720 palabras )
  • Descarga(s) : 0
  • Publicado : 26 de diciembre de 2011
Leer documento completo
Vista previa del texto
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 decodificacion 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.
ARCHIVOS
SUFIJOS
Java usa los siguientes sufijos:

Los archivos de códigofuente tienen extensión .java.
Los archivos binarios tienen extension .class
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 package e import.La primera es package y es seguida de los imports necesarios.
3.Declaraciones de clases e interfaces. Se establece las partes y el orden como deben 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 evitarerrores 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
Existendos 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 quesigue. Se incluyen a continuación de los caracteres //.
DOCUMENTACION
Usados para describir especificaciones del código. Describen las clases, interfaces, contructores, métodos y atributos. Van ubicados antes de la declaración dentro de los caracteres /** y */.
DECLARACIONES
CANTIDAD
Se recomienda hacer una sola declaración por línea, ya que favorece el uso de comentarios.
INICIALIZACION
Esel acto de asignar un valor inicial a una variable u objeto. Deben ser inicializadas inmediatamente en el lugar donde son declaradas, a menos que su valor inicial dependa de un previo cálculo.
UBICACIÓN
Las variables deben ser ubicadas al inicio de cada bloque delimitado por {...}, excepto cuando se hace uso de índices en bucles.
CLASES E INTERFACES
Para la declaración de clases e interfacesse deben considerar los siguientes aspectos:
1.Debe existir al menos una línea en blanco que separe los métodos.
2.No dejar espacios en blanco entre el nombre del método y el paréntesis de la lista de parámetros.
3.La llave de apertura debe estar ubicada al final de la línea de declaración de sentencia.
4.La llave de cierre se indenta al inicio de la línea, de modo que se alinee con lasentencia de apertura, excepto cuando se trata de un método vacío.
SENTENCIAS
DE RETORNO
En el uso de la sentencia return no debe usarse parentesis a menos que el valor devuelto sea resultado de una operación.
IF, IF - ELSE
Esta sentencia siempre lleva llaves en cualquiera de sus casos. Las sentencias else o else if se coloca a continuación de la llave de cierre de if, no en la siguiente línea....
tracking img