Board.KolibriOS.org

Официальный форум KolibriOS
Текущее время: Чт июл 27, 2017 11:31 pm

Часовой пояс: UTC+03:00




Начать новую тему  Ответить на тему  [ 4 сообщения ] 
Автор Сообщение
 Заголовок сообщения: Документация прямо в коде.
СообщениеДобавлено: Вс июн 12, 2011 1:06 am 
Не в сети
Аватара пользователя

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

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

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


Вернуться к началу
 Заголовок сообщения: Re: Документация прямо в коде.
СообщениеДобавлено: Вс июн 12, 2011 1:12 am 
Из критики - комментариев мало и понятны они обычно только авторам.


Вернуться к началу
   
 Заголовок сообщения: Re: Документация прямо в коде.
СообщениеДобавлено: Вс июн 12, 2011 1:14 am 
Не в сети
Аватара пользователя

Зарегистрирован: Вт авг 25, 2009 4:45 pm
Сообщения: 788
Потому их и надо стандартизировать.
Благо знание ассемблера не нужно для редактирования комментариев.
Справиться человек без скиллов программирования


Вернуться к началу
 Заголовок сообщения: Re: Документация прямо в коде.
СообщениеДобавлено: Вс сен 28, 2014 4:11 pm 
Не в сети

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

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


Вернуться к началу
Показать сообщения за:  Поле сортировки  
Начать новую тему  Ответить на тему  [ 4 сообщения ] 

Часовой пояс: UTC+03:00


Кто сейчас на конференции

Сейчас этот форум просматривают: нет зарегистрированных пользователей и 1 гость


Вы не можете начинать темы
Вы не можете отвечать на сообщения
Вы не можете редактировать свои сообщения
Вы не можете удалять свои сообщения
Вы не можете добавлять вложения

Найти:
Перейти:  
Создано на основе phpBB® Forum Software © phpBB Limited
Русская поддержка phpBB