CKTIS / C
comments and documentation — concepto C23
C admite comentarios de bloque `/* ... */` y de línea `// ...`; desaparecen en una fase temprana de traducción y los bloques no pueden anidarse. La documentación debe registrar contratos y motivos, no repetir código evidente.
Versión: C23
Sintaxis
comments and documentationC admite comentarios de bloque /* ... */ y de línea // ...; desaparecen en una fase temprana de traducción y los bloques no pueden anidarse. La documentación debe registrar contratos y motivos, no repetir código evidente.
Un comentario de función debe indicar propiedad de punteros, unidades de tamaño, significado del resultado y condiciones de fallo. Dentro de un algoritmo es útil si explica un invariante no evidente o la razón del orden de operaciones.
Un /* dentro de un bloque no abre otro nivel; el primer */ termina todo y puede exponer código accidental. Una macro no puede “comentar” texto arbitrario de forma fiable; usa un #if 0 controlado y conserva texto válido para el preprocesador.
Ejemplos
#include <stdio.h>
int main(void) {
/* A block comment cannot be nested. */
int value = 6; // The line comment ends at the newline.
printf("%d\n", value + 1);
return 0;
}
Resultado
7
C admite comentarios de bloque `/* ... */` y de línea `// ...`; desaparecen en una fase temprana de traducción y los bloques no pueden anidarse. La documentación debe registrar contratos y motivos, no repetir código evidente.