Статья Автор: Деникина Н.В., Деникин А.В.

Однострочные комментарии

Комментарий – это заметка, удобная для чтения программисту, которая вставляется непосредственно в исходный код программы. Комментарии игнорируются компилятором и предназначены только для использования программистом.

В C++ есть два разных стиля комментариев, которые служат одной цели: помочь программистам каким-то образом документировать код.

Однострочные комментарии

Однострочный комментарий C++ начинается с символов //, которые указывают компилятору игнорировать всё, от символов // до конца строки.

Например:

#include <iostream>
 
int main()
{
   std::cout << "Hello world!" // Всё отсюда до конца строки игнорируется
   return 0;
}

Обычно однострочный комментарий используется для быстрого комментария к одной строке кода.

#include <iostream>
 
int main()
{
   std::cout << "Hello world!\n"; // std::cout живет в библиотеке iostream
   std::cout << "It is very nice to meet you!\n"; // эти комментарии затрудняют чтение кода
   std::cout << "Yeah!\n"; // особенно когда строки разной длины
   return 0;
}

Наличие комментариев справа от строки может затруднить чтение и кода, и комментария, особенно если строка длинная. Если строки достаточно короткие, комментарии можно просто выровнять (обычно по позиции табуляции), например:

#include <iostream>
 
int main()
{
   std::cout << "Hello world!\n";                 // std::cout живет в библиотеке iostream
   std::cout << "It is very nice to meet you!\n"; // это намного легче читать
   std::cout << "Yeah!\n";                        // вам так не кажется?
   return 0;
}

Однако, если строки длинные, размещение комментариев справа может сделать ваши строки очень длинными. В этом случае однострочные комментарии часто помещаются над строкой, которую они комментируют:

#include <iostream>
 
int main()
{
   // std::cout живет в библиотеке iostream
   std::cout << "Hello world!\n";
 
   // это намного легче читать
   std::cout << "It is very nice to meet you!\n";
 
   // вам так не кажется?
   std::cout << "Yeah!\n";
   return 0;
}

Чтобы оставить комментарий нужна авторизация

Печать