作者: ねこ丸
日時: 2003/11/5(20:45)
  ねこ丸です。

  今さらなネタかもしれないんですけど。

  みなさん、ドキュメントってどうやって書いてます？

  いえね、最近（というには少し長いか）PHP で phpdoc ってのを利用してるん
ですよ。まぁ javadoc のパクりなんですが。これが非常に便利なのです。コメ
ントの中のドキュメントの書き方も決まっているのでそれにしたがって書けばい
いだけだし、そうしておくと phpdoc 生成ツールがソースをばーーーっとなめて
HTML（とか）でドキュメント作ってくれる。チョー便利。見やすいし。

  で、Perl の場合はやっぱ pod なんですかね。
  これって各関数の説明を書く用途には向かないですよね。あくまで1枚のファ
イルに対して1つのドキュメントって感じじゃないですか。まさか関数1つ1つフ
ァイルにバラすわけにもいかないし、どうしたものかなぁ、と。
  Perl でよくあるのは

#
# 関数名
#
# 機能とかなんとか
#
sub {
}

  て形でコメント書いておくってやつだと思うんですけど、これを自動的に拾っ
てくれる、phpdoc とか javadoc みたいな虫のいいツールってご存知ないですか？
あるいは誰か作りかけてるとか？

--
    ねこ丸