CKTIS / C++
Komentáře a dokumentace
C++ nabízí komentáře // sahající do konce řádku a blokové komentáře /* ... */. Umožňují vysvětlovat kód a psát dokumentaci, aniž by se jejich obsah vykonával. Blokové komentáře nelze vnořovat.
Verze: C++23; repository compiler flag, production runtime not attested
Syntaxe
// comment
/* comment */Komentář // končí bezprostředně před následujícím znakem nového řádku. Komentář /* ... */ může zabírat více řádků a končí na prvním */. Blokové komentáře se nevnořují: další /* nezačne vnitřní komentář.
Při překladu se každý komentář nahrazuje jednou mezerou, zatímco znaky nového řádku se zachovávají. Proto int/**/value odděluje int a value, kdežto va/**/lue netvoří identifikátor value. Spojování řádků probíhá před rozpoznáváním komentářů: \ na konci řádku obsahujícího komentář // může způsobit, že komentář pohltí i následující fyzický řádek. Tomuto zápisu se vyhněte.
Dokumentační zápisy jako /// a /** ... */ jsou pro jazyk obyčejné komentáře; jejich interpretace jako dokumentace závisí na samostatných nástrojích. Vysvětlujte raději účel, předpoklady a omezení než opakování pokynů v kódu. V příkladu komentář /// popisuje add a blokový komentář odděluje tokeny ve výrazu.
Tento záznam se vztahuje k C++23. Dodaný zdroj je průběžně se vyvíjející pracovní návrh, nikoli neměnné vydání C++23. Nastavení režimu kompilátoru v repozitáři nepotvrzuje prostředí produkčního běhu.
Příklady
#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';
}
Výsledek
5
Zobrazený kód a uvedený výsledek byly ověřeny v izolovaném prostředí metodou zaznamenanou v dokladu o ověření této přesné verze.