RADKRAFT: Doxygen
Doxygenによるソースドキュメントの機械生成 ● Doxygenとは JavaSoftが出している、最も基本的なフリーのJava言語の開発環境J2SE (以前のJDK)に、「JavaDoc」 というツールが含まれているのをご存知でしょうか。 これはソースプログラムに一定の形で書かれたコメントを抜き出して、 HTML文書に自動的に変換してくれるツールです。 フリーウェアDoxygenは、 このJavaDocと同じように、 C++やＣ言語で書かれたソースプログラムのコメントからHTML文書を生成するツールで、 JavaDoc互換のコメントフォーマットのサポート 英語のほか数カ国語(日本語EUCを含む)対応 C++言語のソースが主ターゲットですが、Ｃ言語にも使用可 UNIXとWindows双方のプラットフォームをサポート HTML、LaTeX、UNIX manの
Let’s use doxygen!
はじめに プログラマには、ドキュメント、とくにプログラムの内部仕様書を書くのが苦手、 という人が多い。 その理由は明らかであって、そもそも、ソースコードに (バグも含めて)*1 すべての仕様が子細もらさず書かれているのに、なぜ、さらにそれと独立した仕様書が必要なのかと、 (半ば本気で) 思ってしまうからである。 ソースコードと独立にメンテナンスをしなければならないような仕様書は、 いずれソースコードと整合性が取れなくなって、無意味ならまだしも、 かえって害をなす存在となり果てることもある、ということを、 彼らは経験的に理解しているのである。 (*1) Ruby の作者である、まつもとゆきひろ氏は、 その著者『オブジェクト指向スクリプト言語 Ruby』の中の「付録C Ruby 用語集」で、 次のように書いている: ドキュメント まつもとの苦手なもの。彼は普段から「ソースがドキュメントだ。
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
