Мы все имели дело с проектами без документации. С другой
стороны, проекту не идет на пользу чрезмерная многословность. Однажды мне
показали полку, наполненную талмудами и сказали "Им платили за
документацию". Что бы все прочитать понадобится год.
Программисты часто подходят к требованию написать
комментарий так же, как к обсуждению телесериала "Звездный крейсер ‘Галактика’" или "Доктор Кто":
пишут кучу страниц, выкладывают мельчайшие подробности, но так и не доходят до
сути.
Плохо, если документация не обеспечивает абстракции или
понимания, а лишь искаженно передает функции кода. Получается обычная
транслитерация кода.
Комментариев нет:
Отправить комментарий