CKTIS / C++
Komentáre a dokumentácia
C++ ponúka komentáre // siahajúce po koniec riadka a blokové komentáre /* ... */. Umožňujú vysvetľovať kód a písať dokumentáciu bez vykonávania ich obsahu. Blokové komentáre sa nedajú vnárať.
Verzia: C++23; repository compiler flag, production runtime not attested
Syntax
// comment
/* comment */Komentár // sa končí bezprostredne pred nasledujúcim znakom nového riadka. Komentár /* ... */ môže zaberať viac riadkov a končí sa pri prvom */. Blokové komentáre sa nevnárajú: ďalšie /* nezačne vnútorný komentár.
Pri preklade sa každý komentár nahrádza jednou medzerou, pričom znaky nového riadka sa zachovávajú. Preto int/**/value oddeľuje int a value, kým va/**/lue nevytvára identifikátor value. Spájanie riadkov prebieha pred rozpoznávaním komentárov: \ na konci riadka obsahujúceho komentár // môže spôsobiť, že komentár pohltí aj nasledujúci fyzický riadok. Tomuto zápisu sa vyhnite.
Dokumentačné zápisy ako /// a /** ... */ sú pre jazyk obyčajné komentáre; ich interpretácia ako dokumentácie závisí od samostatných nástrojov. Radšej vysvetľujte účel, predpoklady a obmedzenia, než aby ste opakovali pokyny v kóde. V príklade komentár /// opisuje add a blokový komentár oddeľuje tokeny vo výraze.
Tento záznam sa vzťahuje na C++23. Dodaný zdroj je priebežne sa vyvíjajúci pracovný návrh, nie zmrazené vydanie C++23. Nastavenie režimu kompilátora v repozitári nepotvrdzuje prostredie produkčného behu.
Prí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ýsledok
5
Zobrazený kód a uvedený výsledok boli overené v izolovanom prostredí metódou zaznamenanou v dôkaze o overení tejto presnej verzie.