Comentarios, documentacion y organizacion de archivos (0x02XX)
Reglas de comentarios, documentacion de archivos y organizacion del codigo.
Reglas de comentarios, documentacion de archivos y organizacion del codigo.
Tabla de reglas¶
| Regla | Título | Antipatrones integrados |
|---|---|---|
| 0x0201h | Escribí comentarios que expliquen el ‘porqué’, no el ‘qué’ | — |
| 0x0202h | No dejes código comentado (dead code) en los archivos fuente | — |
| 0x0203h | Prescindí de comentarios obvios, redundantes o vacíos | — |
| 0x0204h | Control de longitud máxima de archivos de código (máx 500 líneas) | — |
| 0x0205h | En archivos .c la inclusión de la cabecera propia debe figurar en primer lugar | — |
| 0x0206h | Validador de presencia de cabecera de documentación obligatoria por archivo | — |