ドキュメント生成ツールとは
プロデル ドキュメント生成ツールとは、プロデルで作成したプログラムから
種類や手順の使い方が書かれたHTML形式のドキュメントを生成するツールです。
プロデルでプログラムを作成した上で、種類や手順に注釈(アノテーション)を加えることで、
その注釈を使ってドキュメントを生成します。
プロデルデザイナには、ドキュメント生成ツールとしてRdrDocが用意されています。
ドキュメント生成用の注釈の作成
ドキュメント生成ツールで出力する説明文は、プロデルプログラムに注釈として指定します。
注釈の例
航空便管理処理とは
※説明 航空便を管理するクラスです。
※作成者 管理システム開発チーム
※バージョン 1.1
+【自分】へ、【航空便情報】で、航空便を、登録する手順
※説明 航空便を登録します。
※引数 航空便情報 登録する航空便情報
終わり
終わり
ドキュメント生成に使用する注釈
ドキュメントに出力する説明には、次の注釈を使うことができます。
注釈 | 意味 |
---|---|
※説明 | 種類、手順および変数の説明 |
※引数 | 引数の説明 |
※戻り値 | 戻り値の説明 |
※例文 | 手順の使用例 |
※例外 | 手順で発生する例外 |
※バージョン | 種類、手順および変数のバージョン |
※作成者 | 種類、手順および変数の作成者 |
ドキュメント生成ツールの起動
プロデルデザイナの「ツール」タブから、ドキュメント生成ツールを起動します。
ドキュメントを生成したいプロデルプログラムをドラッグ&ドロップします。
プロデルプログラムがあるフォルダにHTMLファイルが生成されます。