В С все комментарии начинаются с пары символов /* и заканчиваются парой */. Между слэшем и звездочкой не должно быть пробелов. Компилятор игнорирует любой текст между данными парами символов. Например, следующая программа выводит на экран только hello:
#include <stdio.h>
int main(void)
{
printf("hello");
/* printf("there"); */
return 0;
}
Комментарии могут находиться в любом месте программы, за исключением случая, когда комментарий разбивает на части ключевое слово или идентификатор. Таким образом, следующий комментарий абсолютно корректен:
х = 10 + /* сложение чисел */ 5;
в то время как
swi//* не работает */tch(c) { . . .
некорректно, поскольку ключевое слово не может содержать комментарий. Тем не менее комментарии, как правило, не принято помещать в середину выражения, поскольку в таких случаях труднее разобраться с самим выражением.
Комментарии не могут быть вложенными, т.е. один комментарий не может содержать другой комментарий. Например, следующий фрагмент кода вызовет ошибку при компиляции:
/* внешний комментарий
х = у / а;
/* внутренний комментарий вызывает ошибку */
*/
Комментарии следует использовать, когда необходимо объяснить какую-либо операцию кода. Все функции, за исключением самых очевидных, должны содержать комментарии в начале их объявления, где следует писать, что функция делает, какие параметры она получает и что возвращает.
 |
ЗАМЕТКА: С++ полностью поддерживает С-стиль комментариев. Тем не менее он также позволяет определять однострочные комментарии. Однострочный комментарий начинается с // и заканчивается в конце строки. |