В этом руководстве мы узнаем о комментариях C ++, о том, почему мы их используем и как их использовать, с помощью примеров.
Комментарии C ++ - это подсказки, которые программист может добавить, чтобы упростить чтение и понимание своего кода. Они полностью игнорируются компиляторами C ++.
Есть два способа добавить комментарии к коду:
//
- Однострочные комментарии
/* */
-Многострочные комментарии
Однострочные комментарии
В C ++ любая строка, начинающаяся с символа, //
является комментарием. Например,
// declaring a variable int a; // initializing the variable 'a' with the value 2 a = 2;
Здесь мы использовали два однострочных комментария:
// declaring a variable
// initializing the variable 'a' with the value 2
Мы также можем использовать однострочный комментарий, например:
int a; // declaring a variable
Многострочные комментарии
В C ++ любая строка между /*
и */
также является комментарием. Например,
/* declaring a variable to store salary to employees */ int salary = 2000;
Этот синтаксис можно использовать для написания однострочных и многострочных комментариев.
Использование комментариев для отладки
Комментарии также можно использовать для отключения кода, чтобы предотвратить его выполнение. Например,
#include using namespace std; int main() ( cout << "some code"; cout << ''error code; cout << "some other code"; return 0; )
Если мы получаем ошибку при запуске программы, вместо удаления подверженного ошибкам кода, мы можем использовать комментарии, чтобы отключить его выполнение; это может быть ценным инструментом отладки.
#include using namespace std; int main() ( cout << "some code"; // cout << ''error code; cout << "some other code"; return 0; )
Совет от профессионала: помните, как использовать комментарии; это может быть действительно полезно. Для большинства редакторов кода это Ctrl + /
для Windows и Cmd + /
Mac.
Зачем использовать комментарии?
Если мы будем писать комментарии к нашему коду, нам будет легче понять код в будущем. Кроме того, вашим коллегам-разработчикам будет легче понять код.
Примечание: комментарии не должны заменять способ объяснить плохо написанный код на английском языке. Мы всегда должны писать хорошо структурированный и понятный код. А затем используйте комментарии.
Как правило, используйте комментарии, чтобы объяснить, почему вы что-то сделали, а не как вы что-то сделали, и у вас все хорошо.