[コラム]DoxyCommentでC++でもコメントを自動生成

DoxyCommentでC++でもコメントを自動生成

JavaにはJavadocというコメントから自動的にドキュメントを生成する標準的な機能がありますが、Visual C++には標準ツールはありません。
お勧めなのはdoxygenというドキュメント生成ツールです。ソースファイルのコメントから文書を抜き出し、HTMLをはじめとするさまざまなフォーマットのドキュメントを生成することができます。

DoxygenはQtスタイル及びJavaDocスタイルのコメン トを認識してくれます。
私はお仕事ではJavaプログラマーなのでJavaDocスタイルのコメントに慣れていますのでJavaDoc形式のコメントは助かります。

さて、今回インストールするDoxyCommentですが、そのdoxygen形式のコメントを自動生成してくれるツールです。Visual Studioにアドイン(add-in)して使用します。

別にDoxygenでドキュメント作らないよーという場合でも、ソースにコメントは入れると思います。コメント作成の作業をちょっと楽にしてくれるお勧め便利ツールです。

インストール

プロジェクトのサイト
http://sourceforge.net/projects/doxycomment/
よりインストーラをダウンロードしてインストールしてみました。

Visual Studio2005 用と2008用があります。ご自分の環境にあったファイルをダウンロードしてください。
※現在2008用はベータバージョンのようです。

Visual Studio2005の場合
ダウンロードした、doxycomment_0_4_3_setup.msi をインストールします。

Visual Studioを起動すると画像のようなツールバーがでます。

Comment provider:JavaDocComment を選択し、コマンド接頭辞やコメントブロック概観を好みのスタイルに設定してください。

さらにカスタマイズすれば、自分好みのコメントを自動生成できて、便利に使えるでしょう

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です