База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / C++

Коментари и документация

C++ предлага коментари // до края на реда и блокови коментари /* ... */. Те позволяват да обяснявате кода и да пишете документация, без съдържанието им да се изпълнява. Блоковите коментари не могат да се влагат.

Версия: C++23; repository compiler flag, production runtime not attested

Синтаксис

// comment
/* comment */

Коментарът // завършва непосредствено преди следващия знак за нов ред. Коментарът /* ... */ може да обхваща няколко реда и завършва при първото */. Блоковите коментари не се влагат: допълнително /* не започва вътрешен коментар.

При превод всеки коментар се заменя с един интервал, а знаците за нов ред се запазват. Затова int/**/value разделя int и value, докато va/**/lue не образува идентификатора value. Сливането на редове се извършва преди разпознаването на коментарите: \ в края на ред с коментар // може да накара коментара да обхване и следващия физически ред. Избягвайте този запис.

Форми за документация като /// и /** ... */ са обикновени коментари за езика; тълкуването им като документация зависи от отделни инструменти. Предпочитайте да обяснявате целта, предположенията и ограниченията, вместо да повтаряте инструкциите в кода. В примера коментарът /// описва add, а блоковият коментар разделя токени в израз.

Този запис е за C++23. Предоставеният източник е развиващ се работен проект, а не фиксирано издание на C++23. Настройка на режима на компилатора в хранилище не удостоверява производствената среда за изпълнение.

Примери

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

Резултат

5

Показаният код и заявеният резултат са проверени в изолирана среда по метода, записан в доказателството за проверка на тази точна версия.

Източници