CKTIS / C++
Commentaar en documentatie
C++ biedt //-commentaar dat doorloopt tot het einde van een regel, en blokcommentaar /* ... */. Hiermee kun je code toelichten en documentatie schrijven zonder dat de inhoud wordt uitgevoerd. Blokcommentaar kan niet worden genest.
Versie: C++23; repository compiler flag, production runtime not attested
Syntax
// comment
/* comment */Een //-commentaar eindigt direct vóór het volgende newline-teken. Een /* ... */-commentaar kan meerdere regels beslaan en eindigt bij de eerste */. Blokcommentaar wordt niet genest: een extra /* begint geen binnenste commentaar.
Bij de vertaling wordt elk commentaar vervangen door één spatie, terwijl newline-tekens behouden blijven. Daardoor scheidt int/**/value int en value, terwijl va/**/lue niet de identifier value vormt. Regelvoortzetting vindt plaats voordat commentaar wordt herkend: een \ aan het einde van een regel met een //-commentaar kan ervoor zorgen dat het commentaar ook de volgende fysieke regel omvat. Vermijd deze schrijfwijze.
Documentatievormen zoals /// en /** ... */ zijn voor de taal gewone commentaren; of ze als documentatie worden geïnterpreteerd, hangt af van afzonderlijke hulpmiddelen. Leg bij voorkeur doel, aannames en beperkingen uit in plaats van code-instructies te herhalen. In het voorbeeld beschrijft het ///-commentaar add, en scheidt het blokcommentaar tokens in een expressie.
Dit artikel richt zich op C++23. De aangeleverde bron is een voortdurend bijgewerkt werkdocument, geen vastgelegde C++23-editie. Een instelling voor de compilermodus in een repository geeft geen bevestiging van de productie-runtimeomgeving.
Voorbeelden
#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';
}
Resultaat
5
De getoonde code en het opgegeven resultaat zijn in een geïsoleerde omgeving geverifieerd met de methode die in het verificatiebewijs voor exact deze versie is vastgelegd.