コードのドキュメント化

有名なDoxygenフォーマットのサポートのおかげで、コードをうまくドキュメント化できます。

Doxygenプレビュー

ドキュメントのプレビュー

クイックドキュメントポップアップ（Ctrl+Q）で Doxygen ドキュメントのプレビューを表示できます。 Doxygenコマンドは、型の情報に加えて、解析され、キレイに整列します。

関数のパラメータが関数の説明とは別にドキュメント化されている場合、CLionはすべてのコメントを結合し、関数の完全なシグネチャのドキュメントを表示します（Doxygenが出力を生成するときと同様です）。

Doxygen用の名前変更

安全に名前を変更

ドキュメントを正しく保つために、Renameリファクタリング（Shift+F6）を使用し、関数名、またはそのパラメータを更新します。 CLionはDoxygenのコメントと他の参照を更新します。

Doxygen補完

補完の使用

素早くタイピングできるように、CLionにはDoxygenコマンドと関数パラメータの自動補完機能が搭載されています。

Doxygenコメント生成

ドキュメントの生成

関数について新しいDoxygenのコメントを追加するには、コメントを生成します。 /**、/*!、///または//!と入力して、Enterを押します。 関数にパラメータがある場合、値を返す場合、または例外を投げる場合は、スタブが生成されます。

クイックドキュメント

クイックドキュメント

Quick Documentation popup (Ctrl+Q) is a universal tool to help you get more information on a code element at the caret. デフォルトでは、CLion はマウスオーバー操作で自動的にクイックドキュメントをポップアップ表示します。 呼び出し元の要素に応じて、ポップアップには以下のような情報が表示されます。
  • 関数シグネチャーの詳細。
  • コードのドキュメント（通常または Doxygen コメントのいずれか）。
  • 推論された型。明示的な型が欠落している場合がある最新の C++ で特に役立ちます。
  • 型のサイズ。
  • ネストされたマクロへの理解を深めてデバッグするのに役立つマクロ置換。
  • 定数式の値。
  • 整数としての Enum 値。