perl だって Doxygen が使いたい！
前投稿に引き続いて、自動的にperlソースからドキュメントを作ろう企画。 これは何ですか？ Doxygen は強力なドキュメンテーションツールです。 プログラム中に書かれた定義とかコメントとかを解析して、 美しい HTML にしてくれます。 これがあれば、詳細設計書はばっちり。 （設計書って作る前に書くんじゃ？という話はナシ） しかし、オリジナルの Doxygen は Perl には対応していません。 その代わり、perldoc とか Pdoc とかを使っていたわけですが、 なんつーか、イマヒトツな感が否めません。 そんな Perl に対応してくんないかなーと思っているアナタのために、 エライ人が filter を作ってくれました。 ・Doxygen ・Perl Doxygen Filter インストール Doxygen すらインストールされていなかったので、まずインストール。 RedHa
Let’s use doxygen!
はじめに プログラマには、ドキュメント、とくにプログラムの内部仕様書を書くのが苦手、 という人が多い。 その理由は明らかであって、そもそも、ソースコードに (バグも含めて)*1 すべての仕様が子細もらさず書かれているのに、なぜ、さらにそれと独立した仕様書が必要なのかと、 (半ば本気で) 思ってしまうからである。 ソースコードと独立にメンテナンスをしなければならないような仕様書は、 いずれソースコードと整合性が取れなくなって、無意味ならまだしも、 かえって害をなす存在となり果てることもある、ということを、 彼らは経験的に理解しているのである。 (*1) Ruby の作者である、まつもとゆきひろ氏は、 その著者『オブジェクト指向スクリプト言語 Ruby』の中の「付録C Ruby 用語集」で、 次のように書いている: ドキュメント まつもとの苦手なもの。彼は普段から「ソースがドキュメントだ。
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
