Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / C++

Komentarji in dokumentacija

C++ ponuja komentarje // do konca vrstice in blokovne komentarje /* ... */. Z njimi lahko pojasnimo kodo in pišemo dokumentacijo, ne da bi se njihova vsebina izvajala. Blokovnih komentarjev ni mogoče gnezditi.

Različica: C++23; repository compiler flag, production runtime not attested

Sintaksa

// comment
/* comment */

Komentar // se konča neposredno pred naslednjim znakom za novo vrstico. Komentar /* ... */ lahko obsega več vrstic in se konča pri prvem */. Blokovni komentarji se ne gnezdijo: dodatni /* ne začne notranjega komentarja.

Med prevajanjem se vsak komentar nadomesti z enim presledkom, znaki za novo vrstico pa se ohranijo. Zato int/**/value loči int in value, medtem ko va/**/lue ne tvori identifikatorja value. Združevanje vrstic poteka pred prepoznavanjem komentarjev: \ na koncu vrstice s komentarjem // lahko povzroči, da komentar zajame tudi naslednjo fizično vrstico. Izogibajte se takemu zapisu.

Oblike dokumentacije, kot sta /// in /** ... */, so za jezik običajni komentarji; njihova razlaga kot dokumentacije je odvisna od ločenih orodij. Raje pojasnite namen, predpostavke in omejitve, namesto da ponavljate navodila kode. V primeru komentar /// opisuje add, blokovni komentar pa loči žetone v izrazu.

Ta vnos obravnava C++23. Predloženi vir je sproti spreminjajoči se delovni osnutek, ne zamrznjena izdaja C++23. Nastavitev načina prevajalnika v repozitoriju ne potrjuje produkcijskega izvajalnega okolja.

Primeri

#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';
}

Rezultat

5

Prikazana koda in navedeni rezultat sta bila preverjena v izoliranem okolju z metodo, zapisano v dokazilu o preverjanju te natančne različice.

Viri