Doxygen マニュアル
Doxygen マニュアル このマニュアルは 3つのパートに分かれています。 それぞれのパートは、さらにいくつかのセクションに分かれます。 パート 1 は、ユーザー・マニュアルです。 セクション インストール では、 ダウンロード、コンパイル、 インストールの方法を説明します。 セクション はじめよう では、最初のドキュメントを素早く生成する方法を説明します。 セクション コードのドキュメント付け では、コードにドキュメントを付けるための様々な方法を例示します。 セクション リスト では、リストを作成する様々な方法を示します。 セクション グループ化 では、グループ化の方法を示します。 セクション 式のインクルード では、ドキュメントに式を挿入する方法を示します。 セクション グラフと図 では、Doxygen で生成できる図とグラフを説明します。 セクション プリプロセス では、Doxyg
Doxygen
設定 フォーマット 設定ファイルは、Makefile に似た構造を持つ、自由形式の ASCII テキストファイルで、デフォルトでは Doxyfile という名前になります。 ファイルは、doxygen によって解析されます。 書式設定のため、タブや改行コードを入れられます。 ステートメントは、大文字と小文字が区別されます。 ファイル内のどこにでもコメントを置くことができます (クォートの中を除く)。 コメントは、# 文字で始まり、行の終わりまで続きます。 ファイルは、本質的には、代入文のリストからなっています。 各ステートメントは、大文字で書かれた TAG_NAME の後に = 文字と1つ以上の値が続いたものです。 同じタグへの代入が 2回以上現れた場合は、最後の代入文だけが有効になります。 引数にリストを指定するオプションについては、= のかわりに += 演算子を使って、リストに新しい値
Let’s use doxygen!
はじめに プログラマには、ドキュメント、とくにプログラムの内部仕様書を書くのが苦手、 という人が多い。 その理由は明らかであって、そもそも、ソースコードに (バグも含めて)*1 すべての仕様が子細もらさず書かれているのに、なぜ、さらにそれと独立した仕様書が必要なのかと、 (半ば本気で) 思ってしまうからである。 ソースコードと独立にメンテナンスをしなければならないような仕様書は、 いずれソースコードと整合性が取れなくなって、無意味ならまだしも、 かえって害をなす存在となり果てることもある、ということを、 彼らは経験的に理解しているのである。 (*1) Ruby の作者である、まつもとゆきひろ氏は、 その著者『オブジェクト指向スクリプト言語 Ruby』の中の「付録C Ruby 用語集」で、 次のように書いている: ドキュメント まつもとの苦手なもの。彼は普段から「ソースがドキュメントだ。
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Loading...
