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]  * ОБЗОР  * /  void  RB_Panic  ( char *  причина ,  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 )  ;  }  / ******* /

и результирующий вывод

См. Также [ править ]

• Сравнение генераторов документации

Внешние ссылки [ править ]

• Домашняя страница ROBODoc
• Репозиторий ROBODoc git
• ROBODoc на SourceForge
• Генератор документации для gambas2 и Gambas3: Front-End для RoboDoc