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

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

Комментарии в C++ могут быть двух видов: однострочные и многострочные.

Давайте сразу перейдем к примерам и посмотрим, как можно использовать комментарии в Вашей программе на C++:

#include <iostream>
/*
Это мультистрочный комментарий в языке C++, 
который легко может быть 
перенесён на несколько строк
*/
int main() {
   // это однострочный комментарий в C++
   // ещё один однострочный комментарий
   int x = 0;
   std::cout << "This is a C++ comments demonstration" << std::endl;
}

Как видите, многострочный комментарий располагается выше точки входа нашей программы - метода main(). Он начинается с символов /* и заканчивается символами */. Всё, что попадает между этими символами, не учитывается компилятором и является многострочным комментарием.

Вы можете использовать многострочные комментарии в разных частях Вашей программы на C++.

В самом методе main() идут два однострочных комментария, которые начинаются с символов двойного "слеша", или //. Как нетрудно догадаться, основное отличие от многострочных комментариев, это то, что такой комментарий может располагаться только на одной строке. Точно так же можно задать сколь угодно много однострочных комментариев в Вашей программе, и они также не учитываются при компиляции Вашей программы на C++.

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

• в случае однострочного комментария символы /* и */ не имеют какого-то особого значения и входят в сам однострочный комментарий
• в случае многострочного комментария символы // не имеют какого-то особого значения и входят в сам многострочный комментарий

Давайте для наглядности посмотрим пару примеров, демонстрирующих эти особенности:

#include <iostream>
/*
    Это мультистрочный комментарий.
    Для определения переменной целого типа используйте, например, такую конструкцию:

    int x = 123;    // определение переменной x
*/
int main() {
    // Это однострочный комментарий, и в нём можно использовать как /* , так и */
   std::cout << "This is a very simple example of nested comments in C++ language" << std::endl;
}

При этом Вы не можете использовать внутри многострочного комментария символы */

Причина этого понятна: как только Вы это сделаете, многострочный комментарий "закроется" и последующая пара символов */ уже будет вызывать ошибку компилятора, т.к. это уже будет некорректная конструкция языка C++.

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

int days = 31; // присваиваем переменной значение количества дней в текущем месяце

Вот и всё, как видите, комментарии могут быть очень удобным средством для "заметок" в Вашей программе, при этом они никак не влияют на компиляцию программы и нужны для описания каких-то особенностей её работы, которые пригодятся Вам самим (к примеру, чтобы быстро вспомнить, как работает программа, если откроете её код спустя год), либо для тех программистов, с которыми Вы планируете поделиться исходными кодами Вашей программы на C++