请输入您要查询的百科知识:

 

词条 ROBODoc
释义

  1. History

  2. Example

  3. See also

  4. External links

{{About||the motion picture written by Doug and Scott Gordon MD and distributed by National Lampoon|RoboDoc}}{{Infobox Software
| name = ROBODoc
| logo =
| caption =
| screenshot =
| developer = Frans Slothouber
| released = {{release date|1994}}
| latest release version = 4.99.43
| latest release date = {{release date|2015|04|26}}
| operating system = Linux, Windows, Mac OS, Solaris
| genre = Documentation generator
| license = GNU General Public License
| website = ROBODoc Homepage
}}

ROBODoc is a documentation tool similar to Javadoc and licensed under the GPL. It is used to extract API documentation from source code. It can be used with any language that supports comments and works by extracting specially formatted headers. These are then reformatted into HTML, DocBook, TROFF, ASCII, LaTeX, PDF, or RTF.

It can be used to document any programming artifact, such as: classes, functions, tests, makefile entries, etc.

ROBODoc works with C, C++, Fortran, Perl, shell scripts, Assembler, DCL, DB/C, Tcl/Tk, Forth, Lisp, COBOL, Occam, Basic, HTML, Clarion, and any other language that supports comments.{{fact|date=April 2013}}

History

The first version of ROBODoc was written by Jacco van Weert in 1995. ROBODoc was inspired by the Autodocs program that was available on the Amiga. Autodocs produced ASCII output only. Jacco created a version that created output in Amigaguide format. This made it possible to create hyperlinks between the various documentation parts.

Example

A typical ROBODoc header

  /****f* Robodoc/RB_Panic [2.0d]   * SYNOPSIS   */      void RB_Panic (char* cause, char *add_info)     /*   * FUNCTION   *   Prints an error message.   *   Frees all resources used by robodoc.   *   Terminates program.   * INPUTS   *   * cause    - pointer to a string which describes the   *                cause of the error.   *   * add_info - pointer to a string with additional information.   * SEE ALSO   *   RB_Close_The_Shop ()   * SOURCE   */    {      printf ("Robodoc: Error, %s\",cause) ;      printf ("         %s\", add_info) ;      printf ("Robodoc: Panic Fatal error, closing down..\") ;      RB_Close_The_Shop () ; /* Free All Resources */      exit(100) ;    }       /*******/

and the resulting output

See also

{{Portal|Free and open-source software}}
  • Comparison of documentation generators

External links

  • ROBODoc Homepage
  • [https://github.com/gumpu/ROBODoc ROBODoc git repository]
  • ROBODoc on SourceForge
  • Documentation generator for gambas2 and Gambas3: Front-End for RoboDoc
{{Programming-software-stub}}

1 : Free documentation generators

随便看

 

开放百科全书收录14589846条英语、德语、日语等多语种百科知识,基本涵盖了大多数领域的百科知识,是一部内容自由、开放的电子版国际百科全书。

 

Copyright © 2023 OENC.NET All Rights Reserved
京ICP备2021023879号 更新时间:2024/9/21 2:38:57