ВходНаше всё Теги codebook 无线电组件 Поиск Опросы Закон Среда
17 июля
578462 Топик полностью
fk0, легенда (07.02.2015 20:24, просмотров: 77) ответил symbions на мы используем doxygen и svn
Неоднократно наблюдал случаи, когда доксиген используется, но всё равно ничего не понятно. Причины следующие: 1) вблизи леса не видно. Доксиген документирует функции, например, но в целом, архитектуру, как это работает -- не понять. 2) можно сделаь так, что вроде и задокументировано формально, но всё равно нихрена не понятно. 3) кроме внутренностей программы нужно документировать назначение программы, её настройку, сборку, программирование в контроллер и т.п. вопросы. И всё подряд не обдоксигенишь. Поэтому я имею мнение: доксиген не нужен... Нужно нормально писать комментарии. Не для отъебись (чтоб в доксигене появились), а чтоб понятно было. Писать комментарии на уровне что на входе, что на выходе, писать комментарии "а как это работает" вкратце. Прямо в исходниках. На русском языке. И желательно отдельный документ -- и здесь просто удобно вики-система, где описывать архитектуру, назначение и использование, конфигурацию, сборку, программирование (а-ля ман-страницы). Но каждая палка о двух концах. Тебя уволят нахрен и наймут мальчиков с мамой папой и квартиркой.
[ZX]