Version 3 (modified by rboet, 8 years ago) (diff) |
---|
Tabla de Contenido
- Xamú: Sistema para el Manejo de Matrices de Contabilidad Social V.1.2 …
- Software: Manejo de Matrices de Contabilidad Social V.1.0.1 (2015)
- Análisis del Dominio
- Especificación de las Funcionalidades
- Propuesta de Desarrollo del Proyecto
- Estándares de Desarrollo del Proyecto
- Arquitectura del Software
- Prototipo de la Interfaz Gráfica
- Código Fuente
- Pruebas
- Liberación Versión 1.2
Estándares de Desarrollo del Proyecto
Sobre los archivos
Los archivos preferiblemente tendrán extensión ".Cpp" o en caso de considerarse necesario se utilizara ".C"
Al inicio de cada archivo de recurso (.Cpp o .C) se debe incluir un comentario multilinea como el siguiente
Code highlighting:
/*
Creado bajo la licencia XXX
Autor(es): XXXx y YYY
Fecha: xx/xx/xxxx -> La Fecha Corresponde a cuando se creó el archivo
*/
Normas de Codificación
Las Variables
El nombre de las variables debe ser significativo, y en caso contrario se debe especificar con un comentario de una sola linea que hace.
Por ejemplo:
Code highlighting:
int age = 18; int x = 0; // Componente x de un punto int y = 0;
Las Funciones, Métodos y las Clases
Tanto las funciones, métodos así como las clases deben ser antecedidas por un comentario de multilinea donde se especifique que funcionalidad realizan, autor y fecha. En caso de ser necesario se realizaran comentarios de una línea para especificar algunos procedimientos dentro de la función, método o clase.
Por ejemplo:
Code highlighting:
/* Efectúa la división de dos números reales (a / b), si b es igual a 0 arroja excepción de error de dominio. Autor: José Ruiz Fecha: 20/02/2016 */ float divideFloat(const float & a, const float & b) { if (b == 0) throw std::domain_error("Division by 0");//Arroja un error de división por cero return a / b; }