Let’s use doxygen!
はじめに プログラマには、ドキュメント、とくにプログラムの内部仕様書を書くのが苦手、 という人が多い。 その理由は明らかであって、そもそも、ソースコードに (バグも含めて)*1 すべての仕様が子細もらさず書かれているのに、なぜ、さらにそれと独立した仕様書が必要なのかと、 (半ば本気で) 思ってしまうからである。 ソースコードと独立にメンテナンスをしなければならないような仕様書は、 いずれソースコードと整合性が取れなくなって、無意味ならまだしも、 かえって害をなす存在となり果てることもある、ということを、 彼らは経験的に理解しているのである。 (*1) Ruby の作者である、まつもとゆきひろ氏は、 その著者『オブジェクト指向スクリプト言語 Ruby』の中の「付録C Ruby 用語集」で、 次のように書いている: ドキュメント まつもとの苦手なもの。彼は普段から「ソースがドキュメントだ。
Doxygen
Doxygen の使い方 doxygen はコマンドラインベースのユーティリティです。コマンドラインで--help オプションを付けてコールすると、使用方法の要約が表示されます。 すべてのオプションは、-で始まり、次に一文字が続いて、その後オプションに応じてひとつ以上の引数が続きます。 プロジェクトのマニュアルを生成するには、大抵次の手順を踏んでください。 特殊ドキュメントブロック (セクション特殊ドキュメント・ブロック 参照) でソースコードにドキュメント付けしてください。 -g オプションを付けて doxygen をコールして、設定ファイル (セクション 設定 参照) を生成してください。
Doxygen
設定 フォーマット 設定ファイルは、Makefile に似た構造を持つ、自由形式の ASCII テキストファイルで、デフォルトでは Doxyfile という名前になります。 ファイルは、doxygen によって解析されます。 書式設定のため、タブや改行コードを入れられます。 ステートメントは、大文字と小文字が区別されます。 ファイル内のどこにでもコメントを置くことができます (クォートの中を除く)。 コメントは、# 文字で始まり、行の終わりまで続きます。 ファイルは、本質的には、代入文のリストからなっています。 各ステートメントは、大文字で書かれた TAG_NAME の後に = 文字と1つ以上の値が続いたものです。 同じタグへの代入が 2回以上現れた場合は、最後の代入文だけが有効になります。 引数にリストを指定するオプションについては、= のかわりに += 演算子を使って、リストに新しい値
最近のdoxygenはスゴイ - pyopyopyo - Linuxとかプログラミングの覚え書き -
doxygen*1 と言えば、cやc++のソースコードからドキュメントを自動生成する便利なソフトウェアです。この doxygen、ここ1年ぐらいですごく改良されています。ちょうど昨日(2010/6/15)に最新版の 1.7.0 がリリースされたので、この機会に最新版に乗り換えて、新機能の恩恵にあやかりましょう。 と言うわけで最近の目玉を二つ。 その1: "使いやすい"検索機能 最近のdoxygenは検索機能が付いています。 これはMSDNのオンラインヘルプのような感じで、関数名・変数名でマニュアルが検索できるものです。前方一致で検索するので、たとえば getと入力すれば、即getterの一覧が表示されます。 そして、この機能はブラウザのjavascriptやDHTMLを駆使して実現してあるので、わざわざビューア類を追加インストールする必要もありません。 すばらしい!!! この機能を有効にす
Route 477(2009-09-09)
■ [scheme][english] R6RS仕様の英文をLisp的に読み解いてみる 例外のところを読んでいるのですが、複雑すぎて意味が分からない英文が。 Raises a non-continuable exception by invoking the current exception handler on obj. The handler is called with a continuation whose dynamic environment is that of the call to raise, except that the current exception handler is the one that was in place when the handler being called was installed. [r6rs-libより引用] Lisp的にイ
doxygen用コメントの書き方
コメントの書き方(クラス・関数のコメント) このページの最新版は以下の場所をご覧くださいhttp://sakura-editor.wiki.sourceforge.net/DoxygenComment ソースコード中のコメントをdoxygenの 解説に反映させるためのコメントの書き方です。新規にコメントを入れる場合は以下のルールにできるだけ従うようにしてください。 関数内のコメントはこのルールに従っていただいても意味がありません ので通常のコメントで結構です。ドキュメント生成に関係するのは、 ファイル クラス メンバー関数（Inline含む） メンバー変数 グローバル変数 クラスのメンバーでない関数 定数宣言 (#define, enum) です。 doxygenで認識されるコメント スタイル doxygenではQtスタイル及びJavaDocスタイルのコメン トを認識します．コメントには要
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Doxygen
さらに分かっておきたいトランジスタの種類 − ＠IT MONOist
pkgsrc/doxygen
http://acapulco.dyndns.org/manual/src/zsh/