WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / C++

Kommentare und Dokumentation

C++ bietet //-Kommentare, die bis zum Zeilenende reichen, sowie Blockkommentare /* ... */. Sie ermöglichen es, Code zu erläutern und Dokumentation zu verfassen, ohne dass ihr Inhalt ausgeführt wird. Blockkommentare können nicht verschachtelt werden.

Version: C++23; repository compiler flag, production runtime not attested

Syntax

// comment
/* comment */

Ein //-Kommentar endet unmittelbar vor dem nächsten Zeilenumbruchzeichen. Ein /* ... */-Kommentar kann sich über mehrere Zeilen erstrecken und endet beim ersten */. Blockkommentare lassen sich nicht verschachteln: Ein weiteres /* beginnt keinen inneren Kommentar.

Bei der Übersetzung wird jeder Kommentar durch ein Leerzeichen ersetzt, während Zeilenumbruchzeichen erhalten bleiben. Daher trennt int/**/value die Elemente int und value, während va/**/lue nicht den Bezeichner value ergibt. Die Zeilenverkettung erfolgt, bevor Kommentare erkannt werden: Ein \ am Ende einer Zeile mit einem //-Kommentar kann bewirken, dass der Kommentar auch die nächste physische Zeile erfasst. Vermeide diese Schreibweise.

Dokumentationsformen wie /// und /** ... */ sind für die Sprache gewöhnliche Kommentare; ob sie als Dokumentation interpretiert werden, hängt von separaten Werkzeugen ab. Erläutere vorzugsweise Zweck, Annahmen und Einschränkungen, statt Codeanweisungen zu wiederholen. Im Beispiel beschreibt der ///-Kommentar add, und der Blockkommentar trennt Token in einem Ausdruck.

Dieser Eintrag bezieht sich auf C++23. Die bereitgestellte Quelle ist ein fortlaufend überarbeiteter Arbeitsentwurf und keine eingefrorene C++23-Ausgabe. Eine Compiler-Einstellung für den Sprachmodus in einem Repository bestätigt nicht die Produktionslaufzeitumgebung.

Beispiele

#include <iostream>

/// Return the sum of two integers.
/// Precondition: The mathematical sum of a and b is representable as int.
int add(int a, int b) {
    return a /* first operand */ + b;
}

int main() {
    // Print the result once.
    std::cout << add(2, 3) << '\n';
}

Ergebnis

5

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen