Let’s use doxygen!
はじめに プログラマには、ドキュメント、とくにプログラムの内部仕様書を書くのが苦手、 という人が多い。 その理由は明らかであって、そもそも、ソースコードに (バグも含めて)*1 すべての仕様が子細もらさず書かれているのに、なぜ、さらにそれと独立した仕様書が必要なのかと、 (半ば本気で) 思ってしまうからである。 ソースコードと独立にメンテナンスをしなければならないような仕様書は、 いずれソースコードと整合性が取れなくなって、無意味ならまだしも、 かえって害をなす存在となり果てることもある、ということを、 彼らは経験的に理解しているのである。 (*1) Ruby の作者である、まつもとゆきひろ氏は、 その著者『オブジェクト指向スクリプト言語 Ruby』の中の「付録C Ruby 用語集」で、 次のように書いている: ドキュメント まつもとの苦手なもの。彼は普段から「ソースがドキュメントだ。
Doxygen
Doxygen の使い方 doxygen はコマンドラインベースのユーティリティです。コマンドラインで--help オプションを付けてコールすると、使用方法の要約が表示されます。 すべてのオプションは、-で始まり、次に一文字が続いて、その後オプションに応じてひとつ以上の引数が続きます。 プロジェクトのマニュアルを生成するには、大抵次の手順を踏んでください。 特殊ドキュメントブロック (セクション特殊ドキュメント・ブロック 参照) でソースコードにドキュメント付けしてください。 -g オプションを付けて doxygen をコールして、設定ファイル (セクション 設定 参照) を生成してください。
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
