Для написания комментариев к основным блокам программы на C++ можно следовать таким рекомендациям:
- Включить заголовки в верхнюю часть программы. 2 В них можно указать имя и контактную информацию автора, дату последнего изменения кода, цель программы и, при необходимости, краткое изложение алгоритма или проектные решения. 2 Также можно включить список известных ошибок, недостатков или предложений по улучшению. 2
- Добавить комментарий при создании нового класса или определения функции. 2 В комментарии к классу нужно объяснить его цель, доступные функции и переменные, любые ограничения класса, а также информацию, которая может понадобиться программисту, если он захочет унаследоваться от класса. 2 При определении функции следует описать, что делает эта функция и есть ли у неё побочные эффекты. 2
- Комментировать реализацию функции или алгоритма в случае наличия неочевидных, интересных или важных кусков кода. 5 Блоки кода, отличающиеся сложностью или нестандартностью, должны предваряться комментарием. 5
- Писать комментарий ко всем глобальным переменным. 5 В нём нужно указать назначение переменной и, если не очевидно, почему она должна быть глобальной. 5
В языке C++ есть два типа комментариев: однострочный и многострочный. 14 Однострочный комментарий размещается на одной строке после двойного слеша //. 1 Многострочный комментарий заключается между символами /* текст комментария */ и может размещаться на нескольких строках. 1