Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

Comentarios, documentacion y organizacion de archivos (0x02XX)

Reglas de comentarios, documentacion de archivos y organizacion del codigo.

Universidad Nacional de Río Negro

Reglas de comentarios, documentacion de archivos y organizacion del codigo.

Tabla de reglas

ReglaTítuloAntipatrones integrados
0x0201hEscribí comentarios que expliquen el ‘porqué’, no el ‘qué’
0x0202hNo dejes código comentado (dead code) en los archivos fuente
0x0203hPrescindí de comentarios obvios, redundantes o vacíos
0x0204hControl de longitud máxima de archivos de código (máx 500 líneas)
0x0205hEn archivos .c la inclusión de la cabecera propia debe figurar en primer lugar
0x0206hValidador de presencia de cabecera de documentación obligatoria por archivo