Board.KolibriOS.org

Official KolibriOS board
It is currently Sun Oct 17, 2021 10:43 pm

All times are UTC+03:00




Post new topic  Reply to topic  [ 6 posts ] 
Author Message
PostPosted: Sun Jun 12, 2011 1:06 am 
Offline
User avatar

Joined: Tue Aug 25, 2009 4:45 pm
Posts: 796
Всем известна проблема с документацией в колибри.
Однако современная тенденция - автогенерация документации (а-ля doxygen) из комментариев в коде. В том числе и для FASM

пример скрипта на Perl http://rudy.mif.pg.gda.pl/~bogdro/inne/

Высказываем свои мнения.
В случае критики пожалуйста аргументы, что мешает, и что надо исправить, чтобы не мешало.


Top
   
PostPosted: Sun Jun 12, 2011 1:12 am 
Из критики - комментариев мало и понятны они обычно только авторам.


Top
   
PostPosted: Sun Jun 12, 2011 1:14 am 
Offline
User avatar

Joined: Tue Aug 25, 2009 4:45 pm
Posts: 796
Потому их и надо стандартизировать.
Благо знание ассемблера не нужно для редактирования комментариев.
Справиться человек без скиллов программирования


Top
   
PostPosted: Sun Sep 28, 2014 4:11 pm 
Offline

Joined: Wed Sep 24, 2014 5:47 pm
Posts: 34
XVilka wrote:
Потому их и надо стандартизировать.
Благо знание ассемблера не нужно для редактирования комментариев.
Справиться человек без скиллов программирования

И как, не разбираясь в коде, определить корректность и полноту комментария? :)
С документацией печаль полнейшая, тут согласен. Но писать ее в основном придется ручками, какую-то автоматизацию можно прикрутить только к будущему коду, формализовав процедуры разработки.


Top
   
PostPosted: Tue Jun 29, 2021 3:58 pm 
Offline
User avatar

Joined: Mon Aug 26, 2019 10:14 pm
Posts: 46
Кое кто мог заметить новую ссылку рядом с ссылкой на SVN: теперь у нас есть свое подобие доксигена. Генерируется скриптом asmxygen, уже поддерживает все конструкции, используемые в ядре, что я нашел: макросы, переменные, функции, декларации структур, в будущем планируется доксидокументирование констант.

Использовать Doxygen в ядре уже можно, пример документированной таким способом функции: https://builds.kolibrios.org/doxygen/ht ... 531e1fc75a

В случае появления вопросов или пожеланий по утилите, генерирующей доксиген, для нее создана отдельная тема.

_________________
Если программа не юзабельна под ХРюшей с 128МБ памяти и IDE винчестером, она отстой


Top
   
PostPosted: Thu Jul 01, 2021 1:32 pm 
Offline
User avatar

Joined: Mon Nov 19, 2012 5:22 pm
Posts: 471
Это вау! Реально круто. Жаль, что когда я ковырял ядро, этой штуки не было.

_________________
Чем больше сыра, тем больше в нём дыр. Чем больше дыр, тем меньше в нём собственно сыра. Значит, чем больше сыра, тем меньше сыра!


Top
   
Display posts from previous:  Sort by  
Post new topic  Reply to topic  [ 6 posts ] 

All times are UTC+03:00


Who is online

Users browsing this forum: No registered users and 2 guests


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Search for:
Jump to:  
Powered by phpBB® Forum Software © phpBB Limited