Виды комментариев

- Повторение кода. Такие комментарии не предоставляют дополнительной информации.

- Объяснение кода. Такие комментарии обычно служат для объяснения сложных, хитрых или нестабильных фрагментов кода. В этих ситуациях они полезны, но обычно только потому, что код непонятен. Если код настолько сложен, что требует объяснения, почти всегда разумнее улучшить код, а не добавлять комментарии

- Маркер в коде.

- Резюме кода. Эти комментарии более полезны, чем повторяющие, потому что программист, читающий программу, может просматривать их быстрее, чем код.

- Описание цели кода

- Информация, которую невозможно выразить в форме кода. Эта категория комментариев включает уведомления об авторских правах и конфиденциальности данных, номера версий и другие детали, замечания о структуре кода, ссылки Виды комментариев на релевантные документы требований или архитектуры, ссылки на Интернет-ресурсы, соображения по оптимизации и т. д.

К трем видам комментариев, приемлемых в готовом коде, относятся резюмирующие комментарии, комментарии цели и информация, не выразимая в форме кода.

Выводы

Хороший код сам является самой лучшей документацией. Если код настолько плох, что требует объемных комментариев, попытайтесь сначала улучшить его. Комментарии должны сообщать о коде что-то такое, что он не может сообщить сам — на уровне резюме или уровне цели. Некоторые стили комментирования заставляют выполнять много нудной канцелярской работы. Используйте стиль, который было бы легко поддерживать.


documentaktykej.html
documentaktyror.html
documentaktyyyz.html
documentaktzgjh.html
documentaktzntp.html
Документ Виды комментариев