Forth http://fforum.winglion.ru/ |
|
Системы автодокументации для форта http://fforum.winglion.ru/viewtopic.php?f=24&t=2220 |
Страница 1 из 1 |
Автор: | MrYuran [ Вс июл 26, 2009 09:36 ] |
Заголовок сообщения: | Системы автодокументации для форта |
При рассмотрении различных фортов в одном заметил подобие Doxygen - то есть возможность генерации сводной документации проекта по тегам, размещённым в исходном тексте. А я вот что подумал: неплохо было бы иметь такие слова, которые могут парсить исходники на предмет определений и комментариев. Фактически, эту работу может выполнить штатный интерпретатор входного потока, только результатом будет не компилированное слово в словаре, а текстовый вывод (на экран или в файл) определения и сопутствующих комментариев. Можно в зависимости от настроек только комментариев. Какие у кого есть идеи, может быть, наработки по этой теме? Конечно, в идеале это должно быть так: пишем в специальной среде, подводим курсор к слову - над ним всплывает подсказка со стековым комментарием. Но для начала неплохо бы просто определить какое-нибудь слово, например, doxy, чтобы выводить информацию по конкретному слову или файлу Типа такого: doxy MyWord <Enter> : MyWord ( a b c -- d ) (! Делает то-то и то-то, возвращает нечто) ok Это я всё на тему "как нам обустроить форт" |
Автор: | VoidVolker [ Вс июл 26, 2009 11:21 ] |
Заголовок сообщения: | |
MrYuran писал(а): пишем в специальной среде, подводим курсор к слову - над ним всплывает подсказка со стековым комментарием.
Такой возможностью обладает редактор SciTE, описания слов он берет из *.api. Можно в реальном времени таким образом сканировать каталог с исходниками и генерировать апи-файлы. Честно говоря, я уже давно хотел сделать такую задачку для ннкрона - да все руки не доходят. |
Автор: | MrYuran [ Вс июл 26, 2009 12:58 ] |
Заголовок сообщения: | |
Вот, кое-что сам нашёл, буду разбираться ~ygrek/doc/docbook/ |
Автор: | mOleg [ Пн авг 17, 2009 08:57 ] |
Заголовок сообщения: | |
MrYuran писал(а): А я вот что подумал: неплохо было бы иметь такие слова, которые могут парсить исходники на предмет определений и комментариев.
Фактически, эту работу может выполнить штатный интерпретатор входного потока, только результатом будет не компилированное слово в словаре, а текстовый вывод (на экран или в файл) определения и сопутствующих комментариев. Можно в зависимости от настроек только комментариев. Какие у кого есть идеи, может быть, наработки по этой теме? в некотором роде похожая вещь есть в форке, а именно при сборке системы создается names.xrf файл. Кусочек оттуда: <pre> .\kernel\compiler\print.f PAD# 05C6F7C Cons 9 ( --> const ) BASE 05C6F9E User 9 ( --> addr ) always 05C7011 : 21 ( --> ) HEX 05C7041 : 20 ( --> ) </pre> так вот, стековый коментарий в конце выдирается из исходного текста. аналогичным образом можно поступать и с коментариями, однако, смысла в этом мало. Имхо, черезмерное загромождение исходного текста коментариями тоже очень плохо. К тому же коментарии пишутся для программиста(самого себя в первую очередь), а не для пользователя!!! А это значит, что собранный таким образом коментарий будет не очень полезен. |
Страница 1 из 1 | Часовой пояс: UTC + 3 часа [ Летнее время ] |
Powered by phpBB © 2000, 2002, 2005, 2007 phpBB Group http://www.phpbb.com/ |