#tips

Рекомендации по написанию комментариев к коду от команды Stack Overflow:

1. Комментарии не должны дублировать код.
2. Хорошие комментарии не оправдывают нечеткость кода.
3. Если вы не можете написать четкий комментарий, возможно, проблема в коде.
4. Комментарии должны рассеивать путаницу, а не вызывать ее.
5. Объясняйте неидиоматический код в комментариях.
6. Вставляйте ссылки на исходный источник скопированного кода.
7. Включайте ссылки на внешние источники там, где они будут наиболее полезны.
8. Добавляйте комментарии при исправлении ошибок.
9. Используйте комментарии, чтобы отмечать незавершенные реализации.

Читать подробнее с примерами & слушать обсуждение в подкасте РАДИО-Т (00:34:32-01:20:10)👇.

#tips

Права доступа к файлам: пользователям Linux на заметку