Standar de codigo

Coding estándar

Por: Flores Escandón Severiano

14/08/2010
sevenmx
Huesitos

Objeto, audiencia y responsabilidad

Las normas de codificación tienen por objeto el constituir la base de referencia de los procesos de inspección de código. Se pretende adoptar las inspecciones de código a título experimental dentro del proyecto NovaMedia, con objeto de prevenir errores y reducir el coste deprueba de los productos.
La audiencia destinataria de este documento lo compone esencialmente el equipo de desarrollo del proyecto (en su calidad de autores de código) y el jefe de proyecto (en calidad de revisor).
La responsabilidad de mantener actualizada la documentación de normas de codificación recaerá en el jefe de proyecto en tanto se desarrolle. Si, como resultado de una evaluaciónpositiva de la técnica de revisión de código adoptada, las normas de codificación se extienden en cuanto a su ámbito de aplicación se habrá de determinar en qué persona o personas recae dicha responsabilidad.
Norma cero, sentido común

Las presentes normas de codificación no son un cuerpo legislativo destinado al castigo de infractores impenitentes. La mayoría se relacionan directamente con lanecesidad de mantener código a través del tiempo con el menor esfuerzo posible.
Se producen circunstancias, sobre todo cuando se codifica utilizando estructuras ya definidas por terceros, en las que es imposible cumplir con alguna de estas normas. Llegado este caso la excepción se debe documentar y poner en conocimiento de los restantes miembros del equipo de desarrollo.
Aunque el objeto es mantenereste documento lo mas conciso posible, si durante el proceso de desarrollo se encuentra necesario ampliar el número de normas, documentar mejor las existentes (incluso suprimir alguna de ellas :-), debe proponer lo antes posible y divulgarse cualquier nueva versión de este documento.

Índice

1. Tipos de datos
Norma 1.1 Tipos de Usuario
Norma 1.2 Tipos anónimos
2. Clases
Norma 2.1Miembros públicos
Norma 2.2 Instancias
Norma 2.3 Objetivo de la clase
3. Funciones
Norma 3.1 Especificar argumentos
Norma 3.2 Uso de referencias
Norma 3.3 Uso de funciones inline
4. Variables
Norma 4.1 Variables globales
Norma 4.2 Inicialización de variables
Norma 4.3 Ámbito de las variables
Norma 4.4 Tamaño
5. Asignación de memoria
Norma 5.1 Uso de new
Norma 5.2 Uso de delete[ ]
6.Visibilidad
Norma 6.1 Uso de ficheros .h
Norma 6.2 Visibilidad mínima
7. Presentación de código
Norma 7.1 Número de instrucciones
Norma 7.2 Longitud de línea
| 8. Elección de identificadores
Norma 8.1 Identificadores en Castellano
Norma 8.2 Verbos y sustantivos
Norma 8.3 Otras normas
9. Comentarios
Norma 9.1 Minimizar
Norma 9.2 Cabecera estándar
10. Expresiones
Norma 10.1 Usode if
Norma 10.2 Asignaciones múltiples
11. Instrucciones generales
Norma 11.1 goto
12. Sentencias de control
Norma 12.1 switch
13. Bucles
Norma 13.1 Cálculos independientes
Norma 13.2 Interrupción
Herramientas de programación
14. Compilador C++
Norma 14.1 Nivel de warnings
|
1. TIPOS DE DATOS

Norma 1.1 Tipos de Usuario
Usar tipos definidos por el usuario en lugar de tipospredefinidos.
Motivo
Utilizada debidamente aumenta la legibilidad del código fuente. El objeto es crear identificadores de usuario descriptivos del tipo dato por su contenido y no por el número de bits de memoria que requieren. Así, y sin considerar el código de windows como buen ejemplo, BOOL es mucho mas descriptivo que int.
Ejemplo
// Declaraciones de tipo y variables, Microsoft no lo hace así;-)
enum BOOLE // Declara un tipo enum Booleano
{
FALSO, // 0 por defecto
VERDAD // Verdad = 1
};
// ......
BOOLE RecursoDisponible = FALSO; // Sólo en C++
Norma 1.2 Tipos anónimos
No deben usarse tipos anónimos.
Motivo
Utilizar tipos anónimos contradice la objetivo general de creación de código legible y autodescriptivo, además en una revisión posterior puede llegar a suponerse que...