PerlでJavadoc風コメント

Ads

これは何か?

関数の前に書いたコメントがそのままドキュメントになるって良いよね。
Java ではコメントの書き方のルールがあって、しかも javadoc というツールを使って簡単に API ドキュメントが生成できる。

何で Perl にはコメントの再利用に関するルールやツールが無いんだよー!!。

ということで自分用に作ったのがこれです。

pldoc.pl

これは Javadoc 風コメントを書いた Perl プログラムから API ドキュメントを生成するスクリプトです。

ソース:./pldoc.pl

使い方

  • このプログラムは標準入力から Perl のソースを読み込んで、標準出力に PukiWiki のページを生成します。
  • example.pl の API ドキュメントページを生成する例。
    pldoc.pl < example.pl > example.pl.pukiwiki

利用例

適当なPerlプログラムをフィルタにかけてみました。

コメント

  • コメント -- テスト? 2005-03-25 (金) 01:20:00
  • perldocじゃダメなの? -- 2005-04-04 (月) 03:55:55
  • perldoc 可読性わるすぎ -- 2006-03-30 (木) 10:41:03

トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2006-08-23 (水) 21:54:32 (4495d)