Board.KolibriOS.org
http://board.kolibrios.org/

Документация прямо в коде.
http://board.kolibrios.org/viewtopic.php?f=35&t=1772
Page 1 of 1

Author:  XVilka [ Sun Jun 12, 2011 1:06 am ]
Post subject:  Документация прямо в коде.

Всем известна проблема с документацией в колибри.
Однако современная тенденция - автогенерация документации (а-ля doxygen) из комментариев в коде. В том числе и для FASM

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

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

Author:  Mario [ Sun Jun 12, 2011 1:12 am ]
Post subject:  Re: Документация прямо в коде.

Из критики - комментариев мало и понятны они обычно только авторам.

Author:  XVilka [ Sun Jun 12, 2011 1:14 am ]
Post subject:  Re: Документация прямо в коде.

Потому их и надо стандартизировать.
Благо знание ассемблера не нужно для редактирования комментариев.
Справиться человек без скиллов программирования

Author:  irkant [ Sun Sep 28, 2014 4:11 pm ]
Post subject:  Re: Документация прямо в коде.

XVilka wrote:
Потому их и надо стандартизировать.
Благо знание ассемблера не нужно для редактирования комментариев.
Справиться человек без скиллов программирования

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

Page 1 of 1 All times are UTC+03:00
Powered by phpBB® Forum Software © phpBB Limited
https://www.phpbb.com/