Next: Многострочный комментарий
Up: style
Previous: Заголовочные файлы
Комментарии должны быть только на английском языке и не содержать
грамматических, орфографических и прочих ошибок. Комментарии должны
описывать что и как происходит, какие глобальные переменные изменяются,
ограничения, ошибки. Не следует сильно привязывать комментарии к коду, они
должны быть достаточно общими, чтобы не появлялось необходимости их изменять
при незначительных поправках в коде.
Короткие комментарии должны передавать смысл действия, а не описывать само
действие.
Например:
/* count average value */
вместо
/* summerize elements, divided by count of elements */
Комментарий должен относиться к нескольким строкам - это полезнее чем
описание к каждой строке.
Subsections
Aleks Sherikov
2006-06-01