Есть ли общие требования к комментированию кода?

Как в техзадании обозначить требование комментировать код? Может есть неофициальные стандарты или культура комментирования кода?
  • Вопрос задан
  • 1475 просмотров
Пригласить эксперта
Ответы на вопрос 4
@vanillathunder
Ну по современным тенденциям код не комментируют, а пишут документацию.
https://www.phpdoc.org
Ответ написан
Комментировать
saboteur_kiev
@saboteur_kiev Куратор тега Веб-разработка
software engineer
* Не следует комментировать очевидное. Лучше правильно давать имена методам, классам и переменным
* Если идет исправление бага, бывает удобно указывать номер тикета.
* Комментарии следует писать на английском (исключения могут быть, например 1C, где сам язык программирования русский).
* Для каждого языка могут быть свои требования. php и java имеют встроенные javadoc, phpdoc, которые генерируют документацию, следовательно там уже есть официальный стандарт.
Ответ написан
jamesgoodwin
@jamesgoodwin
Молодой разработчик
Ответ написан
Комментировать
@malbaron
Сильно связано с конкретными языковыми традициями.
Дело в том, что современные языки программирования самодокументирующие.

Читаем как пример как нужно комментировать:
https://github.com/golang/go/blob/master/src/time/...
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы