С++ Комментарии

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

В этом руководстве мы узнаем о комментариях 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 <iostream>
using namespace std;
int main() {
   cout << "some code";
   cout << ''error code;
   cout << "some other code";

   return 0;
}

Если мы получаем ошибку во время выполнения программы, вместо удаления подверженного ошибкам кода мы можем использовать комментарии, чтобы запретить его выполнение; это может быть ценным инструментом отладки.

#include <iostream>
using namespace std;
int main() {
   cout << "some code";
   // cout << ''error code;
   cout << "some other code";

   return 0;
}

Совет профессионала: Помните ярлык для использования комментариев; это может быть очень полезно. Для большинства редакторов кода это Ctrl + / для Windows и Cmd + / для Mac.

<час>

Зачем использовать комментарии?

Если мы напишем комментарии к нашему коду, нам будет легче понять код в будущем. Кроме того, вашим коллегам-разработчикам будет легче понять код.

Примечание. Комментарии не должны заменять способ объяснения плохо написанного кода на английском языке. Мы всегда должны писать хорошо структурированный и понятный код. А затем используйте комментарии.

Как правило, используйте комментарии, чтобы объяснить, почему вы что-то сделали, а не как вы что-то сделали, и вы молодец.