Как писать комментарии в программировании на C
Бенджамин Уокер
Что такое комментарий на языке C?
A комментарий — это объяснение или описание исходного кода программы. Это помогает разработчику объяснить логику кода и улучшает читаемость программы. Во время выполнения комментарий игнорируется компилятором.
В C существует два типа комментариев:
1) Комментарий, который начинается со звездочки-слэша /* и заканчивается косой чертой-звездочкой */. Его можно разместить в любом месте кода, в одной или нескольких строках.
2) Однострочные комментарии, в которых используется двойная косая черта // и предназначены для комментирования отдельных строк.
Пример однострочного комментария
// single line comment example
Вот пример типа комментариев
// C program to demo
// Single Line comment
#include <stdio.h>
int main(void)
{
// This is a single line comment
printf("Guru99");
return 0; // return zero
}
Пример многострочного комментария
/* Sample Multiline Comment Line 1 Line 2 …. … */
Пример многострочного комментария
#include <stdio.h>
int main() {
/* in main function
I can write my principal code
And this in several comments line */
int x = 42; //x is a integer variable
printf("%d", x);
return 0;}
Зачем нужны комментарии?
Хороший программист, который пишет коды, понятные человеку, лучше, чем программист, генерирующий коды, понятные только машине.
Поэтому настоятельно рекомендуется вставлять комментарии в ваш код, поскольку это хорошая практика программирования. Комментарии не влияют на программу, поскольку компилятор игнорирует их.
Комментарии помогают разработчику понять логику/алгоритм кода, если он снова обратится к нему через долгое время.
