Manual de estilo de código - PinaYoryi/P32021 GitHub Wiki
Manual de estilo de código:
- Código en inglés, pero los comentarios en español.
- Los métodos se escribirán en formato:
void metodo() {
Código del método
}
- Las variables privadas seguirán el formato: _nombreDeVariable
- Las variables globales estarán en mayúsculas.
- Los clases y las variables estáticas empezarán por mayúscula.
- En el .h estarán implementados los métodos get() y set() y nada más.
- Los #include estarán preferiblemente en el .cpp.
- Las constructoras harán uso de la secuencia de inicialización.
- Las clases seguirán el formato:
public
protected
private
- Además, dentro de cada uno se seguirá el formato:
variables
métodos
- Los comentarios tendrán un espacio después de '//' y comenzarán por mayúscula
- Se usará el
<summary>
para explicar los métodos que se crea necesario dependiendo del método.