ROBODoc - ROBODoc - Wikipedia

ROBODoc je dokumentační nástroj podobný Javadoc a licencován pod GPL. Používá se k extrakci API dokumentace od zdrojový kód. Lze jej použít s jakýmkoli jazykem, který podporuje komentáře, a funguje tak, že extrahuje speciálně naformátovaná záhlaví. Ty jsou poté přeformátovány na HTML, DocBook, TROFF, ASCII, Latex, PDF nebo RTF.

Může být použit k dokumentaci jakéhokoli programovacího artefaktu, jako jsou: třídy, funkce, testy, položky makefile atd.

ROBODoc pracuje s C, C ++, Fortran, Perl, shell skripty, Assembler, DCL, DB / C, Tcl / Tk, Forth, Lisp, COBOL, Occam, Základní, HTML, Clarione a jakýkoli jiný jazyk, který podporuje komentáře.^{[Citace je zapotřebí ]}

Dějiny

První verzi ROBODoc napsal Jacco van Weert v roce 1995. ROBODoc byl inspirován programem Autodocs, který byl k dispozici na Amiga. Autodocs vyrobeny ASCII pouze výstup. Jacco vytvořil verzi, která vytvořila výstup v Amigaguid formát. To umožnilo vytvářet hypertextové odkazy mezi různými částmi dokumentace.

Příklad

Typická hlavička ROBODoc

  / **** f * Robodoc / RB_Panic [2.0d]   * SYNOPSIS   */      prázdnota RB_Panic (char* způsobit, char *add_info)     /*   * FUNKCE   * Vytiskne chybovou zprávu.   * Uvolní všechny zdroje, které používá robodoc.   * Ukončí program.   * VSTUPY   * * příčina - ukazatel na řetězec, který popisuje   * příčina chyby.   * * add_info - ukazatel na řetězec s dalšími informacemi.   * VIZ TÉŽ   * RB_Close_The_Shop ()   * ZDROJ   */    {      printf ("Robodoc: Chyba,% s n",způsobit) ;      printf ("% s n", add_info) ;      printf („Robodoc: Panická fatální chyba, zavírá se .. n") ;      RB_Close_The_Shop () ; / * Zdarma všechny zdroje * /      výstup(100) ;    }       /*******/

a výsledný výstup

Viz také

• Porovnání generátorů dokumentace

externí odkazy

• Domovská stránka ROBODoc
• Úložiště ROBODoc git
• ROBODoc na SourceForge
• Generátor dokumentace pro gambas2 a Gambas3: Front-end pro RoboDoc

Tento programovací nástroj související článek je a pahýl. Wikipedii můžete pomoci pomocí rozšiřovat to.