Delphi ／ドキュメント生成ツール

カテゴリー: ぷろぐらみんぐ

2005-06-13

Delphiに使えるドキュメント生成ツール

・PasDoc SJIS対応版＋PasDoc GUI

出力：[ HTML, HtmlHelp, LaTeX , latex2rtf　]
説明書： SupportedTags 、 WritingDocumentation
構文：

なにもしなくても勝手にひろってくれるみたい

コメント内に

修正：R1 (0.8.8j)の場合

@タグ (内容)
といった形で動作を指定できるみたいです。

：R2 (0.8.8.3j) 2005-06-14の場合

@タグ内容
()をつけりるとエラーおこすみたい
といった形で動作を指定できるみたいです。

コメントマーカーというのを決めると、コメント処理の動作を決めれるみたい
デフォルトではついていないので(Javadocスタイル？)、公式サイトでは、:がついていたりする。
今回は普通のコメントと区別するために ! を使おうと思います
{! }みたいな感じです
()をいれていなかったので、warningがでて１時間苦戦しました。

{! @abstract (
このユニットは・・・
)
@created (2005-05-02)
}
unit taRvJpMemo;

いれたい変数や関数の直前に{! 説明}を書きます。

操作は簡単。　出力高速。　
出力結果は、きれいだけど
・・・・・　図がグラフになっていない

・Doxygen　＋　Pas2Dox

出力：[ RTF(MS-Word), PDF, compressed HTML, PostScript, Unix man ]
対応言語：

Delphi, C++, C, Java, Objective-C , PHP
, C#, D , IDL (Corba and Microsoft flavors)

ダウンロードは、Setupを選ぶ。
フォルダ：日本語フォルダ不可・・・

使い方
http://www.hexe19.net/doxygen/quickstart-delphi.html
http://www.fides.dti.ne.jp/~oka-t/doxygen.html
http://members.at.infoseek.co.jp/sakura_editor/comment-rule.html

サンプルを見る限りきれい。みやすい。
が・・・・操作が面倒
っていうか　日本語フォルダをつかえないので選択肢から除外。

・DelphiCodeToDoc
　http://dephicodetodoc.sourceforge.net/

考察
１）どちらにするか・・・・かなり悩む・・・

C#で書き出すことを考えると・・・doxygenにしたほうがいいけど
C#のユニット作ってないのでまぁいいとしよう。CなんかMOに眠ったままだし。
と思っていたけど
doxygenを試すと日本語フォルダを認識しないので使えない。　ソースを英語フォルダにコピーして実行してみたが、　上のサイトのような物は表示されなかった。　ファイル名がでる程度・・・・
設定ファイルを見る限り
TStringListのValueを使えば簡単に変更できるので設定ツールを作る手もあるがばかばかしくて作る気はおきない。　どこか探せばおちているだろうし

２）ということで
PasDoc　にしたんだけど、 Type a= (v);
のときに @valueをしてみたが出力できない
vの前にコメントを貼ればできるが。。。
後方にコメントして、説明にできるタグはないのかな・・・・と思う

こちらはこちらで　不具合が。。。
でも、　お手軽
（

編集

：　R2 (0.8.8.3j) 2005-06-14をいれるとできました。
　　でも、今度はクラス階層が変。継承しているのに同じ段になった・・・）

どちらにしても
自分用の作って
テンプレートをＣＴＲＬ＋Ｊ　に登録して使うといい

() 構文がきかなくなったのが困りものだが・・・

テンプレート集
?

?

?