Семена / 2024 /

15.06.2024 15:26 Главное правило написания комментариев

Для написания полезных документирующих комментариев к исходному коду достаточно придерживаться следующего правила.

1. Действия (функции и методы, выражения и утверждения) должны отвечать на вопрос "Что делает?"
2. Структуры хранения данных (типы данных, поля, постоянные и переменные, а также интерфейсы и классы) должны отвечать на вопрос "Что это?"

Благодарю человека, который в 2010-м подсказал мне это правило, чем упростил написание аккуратного кода.