Doxygenコメント

プログラムのドキュメントを残す為、Doxygenを使います。
このDoxygenを使えばソースコードからドキュメントを自動で生成できます。

自分は、Qtスタイルで記述し、

/*! 複数行コメント */
//! 単数行コメント
//!< 追加コメント

ファイルヘッダは、

/*!
 \file   aaa.cpp
 \brief  aaa c library
 \author aaa
*/

• file:ファイル名
• breif:ファイルの説明
• author:名前

関数ヘッダは、

/*!
 \brief aaa
 \param aaa
 \return aaa
*/

• breif:関数の説明
  
• param:引数名
  
• return:返り値の説明
  

変数ヘッダは、

//! number
int a;