ROBODocはJavadocに似たドキュメントツールで、GPLライセンスに基づいています。ソースコードからAPIドキュメントを抽出するために使用されます。コメントをサポートするあらゆる言語で使用でき、特殊な形式のヘッダーを抽出して動作します。抽出されたヘッダーはHTML、DocBook、TROFF、ASCII、LaTeX、PDF、またはRTFに再フォーマットされます。
| ロボドック | |
|---|---|
| 開発者 | フランス・スロットーバー |
| 初回リリース | 1994 （1994年） |
| 安定版リリース | 4.99.44 / 2021年1月29日 ( 2021-01-29 ) |
| リポジトリ | github |
| 書かれた | C |
| オペレーティング·システム | Linux、Windows、Mac OS、Solaris |
| タイプ | ドキュメントジェネレーター |
| ライセンス | GNU一般公衆利用許諾契約書 |
| Webサイト | ROBODocホームページ |
クラス、関数、テスト、makefile エントリなどのあらゆるプログラミング成果物を文書化するために使用できます。
ROBODoc は、 C、C++、Fortran、Perl、シェル スクリプト、アセンブラ、DCL、DB/C、Tcl/Tk、Forth、Lisp、COBOL、Occam、Basic、HTML、Clarion、およびコメントをサポートするその他の言語で動作します。
歴史
ROBODocの最初のバージョンは、1995年にJacco van Weertによって作成されました。ROBODocは、Amigaで利用可能だったAutodocsプログラムに触発されました。AutodocsはASCII出力のみを生成しました。Jaccoは、 Amigaguide形式で出力を生成するバージョンを作成しました。これにより、様々なドキュメント部分間のハイパーリンクを作成できるようになりました。
例
典型的なROBODocヘッダー
/****f* Robodoc/RB_Panic [2.0d] * 概要 */ void RB_Panic ( char * cause , char * add_info ) /* * 機能 * エラー メッセージを出力します。 * robodoc が使用するすべてのリソースを解放します。 * プログラムを終了します。 * 入力* * cause - エラーの原因 を説明する文字列へのポインタ。 * * add_info - 追加情報を持つ文字列へのポインタ。 * 参照 * RB_Close_The_Shop () * ソース */ { printf ( "Robodoc: エラー、%s \n " 、cause ) ; printf ( " %s \n " 、add_info ) ; printf ( "Robodoc: パニック 致命的なエラー、終了します。.. \n " ) ; RB_Close_The_Shop () ; /* すべてのリソースを解放します */ exit ( 100 ) ; } /*******/そしてその結果の出力
参照
外部リンク
- ROBODocホームページ
- ROBODoc gitリポジトリ
- SourceForge の ROBODoc
- gambas2 および Gambas3 用ドキュメントジェネレーター: RoboDoc のフロントエンド
 | このプログラミングツール関連の記事はスタブです。不足している情報を追加してWikipediaに貢献してください。 |
