Комментарии

Комментарии служат своего рода внутрикодовой документацией. При вставке в программу они фактически игнорируются компилятором; они предназначены исключительно для использования в качестве заметок людьми, читающими исходный код. Хотя спецификация C++ не включает конкретную документацию, существуют различные утилиты, которые анализируют комментарии с разными форматами документации.

Синтаксис

Все комментарии удаляются из программы на фазе трансляции 3 путём замены каждого комментария одним символом пробела.

Комментарии в стиле C

Комментарии в стиле C обычно используются для комментирования больших блоков текста, но они могут использоваться и для комментирования отдельных строк. Для вставки комментария в стиле C просто заключите текст в /* и */; это заставит компилятор проигнорировать содержимое комментария. Хотя это не часть стандарта C++, /** и */ часто используются для обозначения блоков документации; это допустимо, потому что второй звёздочка просто рассматривается как часть комментария. Комментарии в стиле C не могут быть вложены.

Комментарии в стиле C++

Комментарии в стиле C++ обычно используются для комментирования отдельных строк, но несколько комментариев в стиле C++ могут быть размещены вместе, чтобы сформировать многострочные комментарии. Комментарии в стиле C++ говорят компилятору игнорировать всё содержимое между // и новой строкой.

Примечания

Поскольку комментарии удаляются до стадии препроцессора, макрос не может быть использован для формирования комментария, а незавершенный комментарий в стиле C не переходит из включаемого файла.

Помимо комментирования, другие механизмы, используемые для исключения фрагментов исходного кода:

#if 0
    std::cout << "this will not be executed or even compiled\n";
#endif

и

if (false)
{
    std::cout << "this will not be executed\n";
}

Пример

#include <iostream>
 
/* C-style comments can contain
multiple lines */
/* or just one */
 
/**************
 *  you can insert any *, but
 *  you can't make comments nested
 */
 
// C++-style comments can comment one line
 
// or, they can
// be strung together
 
int main()
{
    // comments are removed before preprocessing,
    // so ABC is "1", not "1//2134", and "1 hello world"
    // will be printed
#define ABC 1//2134
    std::cout << ABC << " hello world\n";
 
    // The below code won't be run
    // return 1;
 
    // The below code will be run
    return 0;
}

1 hello world

См. также