C ++：Doxygen-dummyでドキュメンテーションを作成する

ほとんどのプログラマーは、独自のコードをコメントすることを嫌う以上にドキュメントを作成することは嫌です。 Doxygenと入力すると、後でドキュメンテーションを作成するためにコメントにタグを埋め込むことができます。

Doxygenのインストール

DoxygenにはCode：：ブロックは付いていません（少なくともこの記事の時点ではありません）。アプリケーションに適切なバージョンのDoxygenをダウンロードする必要があります。 （Code：：BlocksサイトのDoxygenウェブサイトへのリンクもあります）DoxygenorgのWebサイトにリンクした後、ダウンロードページに移動して、ご使用のオペレーティングシステムのDoxygenのバージョンを確認できます。

<！ - 1 - >

お使いのオペレーティングシステムに適したバージョンをダウンロードしてインストールします。デフォルトを受け入れることはできますが、インストールウィザードがDoxygen実行可能ファイルをどこに置くかを覚えておいてください。

Code：：Blocksを開始します。 [DoxyBlocks]→[環境設定を開く]を選択します。ここから[全般]タブを選択し、Doxygenへのパスを設定します。 WindowsのデフォルトのパスはC：Program Filesdoxygenbindxygenです。これは前の段落でメモしたパスです。 EXE。 Doxywizardへの道についても同じことをしてください。ここでは、Windowsのデフォルトはです。 exe 。 ドキュメントをHTML形式で生成する場合、他のツールは不要なので空白のままにすることができます。 <！ Doxygenは特別なコメントを使用して、ツールがドキュメントを作成するのに役立つキーワードをフラグ付けします。戸惑うほど、Doxygenはいくつかの異なる標準を受け入れますが、デフォルトはJavaDocのように見えるものであり、 / **

コメントです。 （DoxyBlocks→環境設定を開き、コメントスタイルタブを選択することで、コメントスタイルを他のスタイルに変更できます）。

<！ - 3 - >

これがどのように機能するかを見るには、カーソルを関数の先頭に置き、DoxyBlocks→コメントを選択（またはCtrl + Alt + Bを押す）を選択します。 / ** brief * * param accList list&* return void * *以下のようなコメントが表示されます（次の例では、ダウンロード可能な素材のwww.dummies.com / extras / cplusplusに表示されているBudget5プログラムを使用しています） / void getAccounts（list&accList）{ Code：：Blocksは

/ **で始まるDoxygenブロックコメントを挿入します。

Doxygenは、このコメントが直後の関数定義に属することを知っています。 Doxygenのキーワードは、（バックスラッシュ）で始まります。

brief

キーワードは、関数の簡単な説明にフラグを付けます。簡単な説明は複数の行にまたがることができます。これは、表形式のディスプレイに表示される機能の簡単な説明です。 プログラマは、 詳細 キーワードでフラグが立てられた、より詳細な記述でこれを続けることができます。この詳細な説明は、関数が何をするのかについてのより完全な記述を与える。 Doxygenキーワードの多くはオプションです。特に、

brief の記述から空白行だけで区切られた段落を開始すると、 details

キーワードが仮定されます。 これを超える行は、関数の各引数を記述するためにキーワード param でフラグが立てられた行です。最後に、 return

キーワードは、関数が返す値を記述します。 / ** brief getAccounts - キーボードからアカウントを入力します。*詳細この関数はキーボードから入力を読み込みます。 *入力されたすべてのSまたはCについて、関数は新しい* SavingsまたはCheckingのアカウントオブジェクトを作成し、* accountリストに追加します。 Xがエントリを終了します。他の*入力はデポジット（* 0以上の数字）または脱退（0未満の数字）とみなされます。 * * param accList list&getAccounts（）によって作成されたアカウント*オブジェクトのリスト* return void * / void getAccounts（list&accList）{ 同じ行にDoxygenコメントを追加することもできます。これは、データメンバーにコメントするときに最もよく使用されます。カーソルを行末に置き、DoxyBlocks→Line Commentを選択するか、Ctrl + Alt + Lを押します。データメンバーの説明を記入してください。結果は、Budget5からも取った次の例のようになります。 ダブルバランス。 / ** <当座預金残高* / Doxygenドキュメントの生成Doxygenはいくつかの異なるフォーマットでドキュメントを生成することができます。 HTML形式は、閲覧するだけで何のブラウザも必要としないので、特に便利です。

デフォルトはHTMLですが、フォーマットを変更する場合はDoxyBlocks→Preferencesを開き、Doxyfile Defaults 2タブを選択します。このウィンドウでは、生成するさまざまな形式をすべて選択できます。 ドキュメントを初めて抽出する前に、いくつかのオプションを選択することをお勧めします。 DoxyBlocks→Preferencesを開き、Doxyfile Defaultsタブを選択します。 [すべて展開]ボックスがオンになっていることを確認します。次に、Doxyfile Defaults 2タブを選択し、Class_Diagramsチェックボックスをオンにします。次に、[全般]タブを選択し、[コンパイル後にHTMLを実行]チェックボックスをオンにします。 [OK]をクリックすると、完了です。 （オプションはdoxyfileというファイルにオプションが保存されるので、これを再度実行する必要はありません）。 ドキュメントを生成して表示するには、DoxyBlocks→Extract Documentationを選択します。かなり短い間隔の後、Doxygenは次の図に示すようなドキュメントを使用してお気に入りのブラウザを開きます。

入力エラーに関しては、Doxygenはあまりユーザーフレンドリーではありません。ときどきDoxygenは、明白な理由がないため、あなたのソースのある時点でドキュメンテーションの生成を止めるだけです。doxygenをチェックしてください。抽出中に発生した可能性のあるエラーについては、doxyfileと同じディレクトリに含まれるログ・ファイル。

次の図は、左側のウィンドウにプロジェクトブラウザを表示し、ユーザーがプロジェクトのドキュメント内をナビゲートできるようにします。右側では、より詳細な説明を得るためにgetAccounts（）関数が選択されています。最初の行に簡単な説明が表示され、その後に詳細な説明、パラメータ、および戻り値が表示されます。

クラスのドキュメントは、次のコードスニペットに示すように同様に徹底的です。

/ ** class Account *抽象銀行口座を要約します。 *詳細この抽象クラスは* accountscommonを両方の勘定科目に取り入れています：*小切手と貯蓄。ただし、2つの* / class Account {

Account

のドキュメントがここに表示されます：とは異なる* concept withdrawal（）がありません。クラス

アカウント

。

これは簡単な説明です。 Moreをクリックすると、詳細な説明が表示されます。また、

Account

、

その親クラス、およびその子クラスの間の継承関係のグラフ表示に注目してください。