« パスワードが見えています | トップページ | 再起動のたびにウィンドウがズレます »

2014年6月23日 (月)

せっかくだからDoxgenを勉強するぜ その1

ソースコードへのコメントを今はワンラインコメント("//")で入れています。
あまりに貧弱な英語力のため、詳細な説明は全然入っていません。

コード自体がシンプル(なにもしていない)なので、たぶん最低限のコメントで問題ないかと思うのですが…

リファクタリングしながら、コメントを書こうかなと思いたち、Doxygenで勉強してみようかと思います。

コメント部分に必要なフォーマットで説明を入れると、自動で設計ドキュメントなどが生成されるそうです。

日本語のマニュアルが以下にありました。

http://www.doxygen.jp/manual.html

Cygwin64では、全パッケージを入れるとDoxygenパッケージがインストールされます。Ubuntuでは、

sudo apt-get install doxygen

とすれば関連パッケージがインストールされます。

ですので、最初の「セクション インストール」はスキップして「セクション はじめよう」から始めます。

ここでは大まかな流れが説明されています。

大昔に「javadoc」用コメントは書いたことがあったのですが、なんとなく似てます。少し違うのは、関数の先頭とかで大きなコメントとしていろいろ書く傾向ではなく、関数/変数の定義・宣言のところにそれぞれの説明を分けて書くと
いう傾向にあるということでしょうか。

「関数宣言の直前にあるコメントは、関数に関する説明だろう」
「変数宣言の直後にあるコメントは、変数に関する説明だろう」

というふうに、大雑把にソースコードを眺めて、関連付けてくれるみたいです。

« パスワードが見えています | トップページ | 再起動のたびにウィンドウがズレます »

コメント

コメントを書く

コメントは記事投稿者が公開するまで表示されません。

(ウェブ上には掲載しません)

トラックバック

この記事のトラックバックURL:
http://app.f.cocolog-nifty.com/t/trackback/2011805/56589675

この記事へのトラックバック一覧です: せっかくだからDoxgenを勉強するぜ その1:

« パスワードが見えています | トップページ | 再起動のたびにウィンドウがズレます »