ソースコードドキュメントの追加

コードにコメントを追加して、関数、クラス、およびメソッドのドキュメントを生成できます。IDE は Doxygen 構文を使用するコメントを認識して、ドキュメントを自動的に生成します。また、コメントブロックを自動的に生成して、コメントの下の関数のドキュメントを作成します。

1. quote.cc ファイルで、行 int readNumberOf(const char* item, int min, int max) { の上の行にカーソルを置きます。

2. スラッシュと 2 つのアスタリスク (/**) を入力し、Enter を押します。エディタによって、readNumberOf クラスに Doxygen 形式のコメントが挿入されます。

   

3. @param の各行に説明のテキストを追加して、ファイルを保存します。

4. readNumberOf クラスをクリックして黄色で強調表示し、右側の出現箇所マークの 1 つをクリックしてクラスが使用されている場所にジャンプします。

   

5. ジャンプ先の readNumberOf クラスをクリックして、Ctrl-Shift-Space を押してパラメータに追加したドキュメントを表示します。

   

6. ファイル内の任意の場所をクリックしてドキュメントウィンドウを閉じて、readNumberOF クラスを再度クリックします。

7. 「ソース」>「ドキュメントの表示」を選択して、クラスのドキュメントウィンドウを再度開きます。