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;
}

Sobre Códigos de otros Autores

En caso de implementar fragmentos de códigos, funcionalidades, entre otros, se debe usar un formato que identifique el autor original, el sitio de donde se extrajo el código y los datos de la persona que modificó el código, como se presenta en el siguiente ejemplo:

Code highlighting:

/*
   Creado Originalmente por: XXXXX
   Código en: https://micodigo.com/ejemplo_clase_c++
   Modificado por: XXXXXX
   Fecha: xx/xx/xxxx
*/