CKTIS / C
comments and documentation — Konzept C23
C unterstützt Blockkommentare `/* ... */` und Zeilenkommentare `// ...`; sie verschwinden in einer frühen Übersetzungsphase, und Blockkommentare können nicht verschachtelt werden. Dokumentation soll Verträge und Gründe festhalten statt offensichtlichen Code zu wiederholen.
Version: C23
Syntax
comments and documentationC unterstützt Blockkommentare /* ... */ und Zeilenkommentare // ...; sie verschwinden in einer frühen Übersetzungsphase, und Blockkommentare können nicht verschachtelt werden. Dokumentation soll Verträge und Gründe festhalten statt offensichtlichen Code zu wiederholen.
Ein Funktionskommentar sollte Zeigerbesitz, Größeneinheiten, Ergebnisbedeutung und Fehlerbedingungen nennen. Ein kurzer Kommentar im Algorithmus ist nützlich, wenn er eine nicht offensichtliche Invariante oder den Grund der Operationsreihenfolge erklärt.
Eine /*-Folge im Blockkommentar öffnet keine neue Ebene; das erste */ beendet alles und kann versehentlichen Code freilegen. Ein Makro kann beliebigen Text nicht zuverlässig „auskommentieren“; nutze kontrolliertes #if 0 und beachte, dass der Text für den Präprozessor gültig bleiben muss.
Beispiele
#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;
}
Ergebnis
7
C unterstützt Blockkommentare `/* ... */` und Zeilenkommentare `// ...`; sie verschwinden in einer frühen Übersetzungsphase, und Blockkommentare können nicht verschachtelt werden. Dokumentation soll Verträge und Gründe festhalten statt offensichtlichen Code zu wiederholen.