Всем известна проблема с документацией в колибри.
Однако современная тенденция - автогенерация документации (а-ля doxygen) из комментариев в коде. В том числе и для FASM
пример скрипта на Perl http://rudy.mif.pg.gda.pl/~bogdro/inne/
Высказываем свои мнения.
В случае критики пожалуйста аргументы, что мешает, и что надо исправить, чтобы не мешало.
Документация прямо в коде.
Из критики - комментариев мало и понятны они обычно только авторам.
Потому их и надо стандартизировать.
Благо знание ассемблера не нужно для редактирования комментариев.
Справиться человек без скиллов программирования
Благо знание ассемблера не нужно для редактирования комментариев.
Справиться человек без скиллов программирования
И как, не разбираясь в коде, определить корректность и полноту комментария?XVilka wrote:Потому их и надо стандартизировать.
Благо знание ассемблера не нужно для редактирования комментариев.
Справиться человек без скиллов программирования
С документацией печаль полнейшая, тут согласен. Но писать ее в основном придется ручками, какую-то автоматизацию можно прикрутить только к будущему коду, формализовав процедуры разработки.
Кое кто мог заметить новую ссылку рядом с ссылкой на SVN: теперь у нас есть свое подобие доксигена. Генерируется скриптом asmxygen, уже поддерживает все конструкции, используемые в ядре, что я нашел: макросы, переменные, функции, декларации структур, в будущем планируется доксидокументирование констант.
Использовать Doxygen в ядре уже можно, пример документированной таким способом функции: https://builds.kolibrios.org/doxygen/ht ... 531e1fc75a
В случае появления вопросов или пожеланий по утилите, генерирующей доксиген, для нее создана отдельная тема.
Использовать Doxygen в ядре уже можно, пример документированной таким способом функции: https://builds.kolibrios.org/doxygen/ht ... 531e1fc75a
В случае появления вопросов или пожеланий по утилите, генерирующей доксиген, для нее создана отдельная тема.
Это вау! Реально круто. Жаль, что когда я ковырял ядро, этой штуки не было.
Чем больше сыра, тем больше в нём дыр. Чем больше дыр, тем меньше в нём собственно сыра. Значит, чем больше сыра, тем меньше сыра!
Who is online
Users browsing this forum: No registered users and 0 guests