Разработчик (и) | Frans Slothouber |
---|---|
Первоначальный выпуск | 1994 (1994) |
Стабильный выпуск | 4.99.43 / 26 апреля 2015 г. (2015-04-26) |
Операционная система | Linux, Windows, Mac OS, Solaris |
Тип | Генератор документации |
Лицензия | Стандартная общественная лицензия GNU |
Веб-сайт | Домашняя страница ROBODoc |
ROBODoc - это инструмент для документирования, аналогичный Javadoc и лицензируемый по GPL. Он используется для извлечения документации по API из исходного кода. Его можно использовать с любым языком, который поддерживает комментарии, и работает, извлекая специально отформатированные заголовки. Затем они переформатируются в HTML, DocBook, TROFF, ASCII, LaTeX, PDF или RTF.
Его можно использовать для документирования любых программных артефактов, таких как: классы, функции, тесты, записи make-файла и т. Д.
ROBODoc работает с C, C ++, Fortran, Perl, сценарии оболочки, Assembler, DCL, DB / C, Tcl / Tk, Forth, Lisp, COBOL, Occam, Basic, HTML, Clarion и любой другой язык, поддерживающий комментарии.
Первая версия ROBODoc была написана Якко ван Виртом в 1995 году. ROBODoc был вдохновлен программой Autodocs, которая была доступна на Amiga. Autodocs производил только вывод ASCII. Жакко создал версию, которая создавала выходные данные в формате Amigaguide. Это позволило создать гиперссылки между различными частями документации.
Типичный заголовок ROBODoc
/ **** f * Robodoc / RB_Panic [2.0d] * SYNOPSIS * / void RB_Panic (char * cause, char * add_info) / * * FUNCTION * Печатает сообщение об ошибке. * Освобождает все ресурсы, используемые robodoc. * Завершает программу. * INPUTS * * cause - указатель на строку, описывающую * причину ошибки. * * add_info - указатель на строку с дополнительной информацией. * СМОТРИ ТАКЖЕ * RB_Close_The_Shop () * ИСТОЧНИК * / {printf («Robodoc: Ошибка,% s \ n», причина); printf ("% s \ n", add_info); printf ("Рободок: паника, фатальная ошибка, закрытие.. \ n"); RB_Close_The_Shop (); / * Освободить все ресурсы * / exit (100); } / ******* /
и итоговый результат
.