doxygenで認識されるコメントブロック

コメントブロックに囲いを付けると認識されない.

doxygenでの関数のコメントブロックは以下のような感じ.

/**
 * @brief       Description
 * @param[in]   int arg_a : description for input argument
 * @param[out]  int arg_b : description for output argument
 * @return      int : description for return value
 */

ただこれだと区切りがないのでスクロールしたときにわかりにくい(年寄りかよ). vscodeでcを書くぶんにはoutlineがあるのでそこまで必要かという問題もあるが, 普段VHDLをやっているのでテキストだけでわかりやすいのも大事.

ということで

悪い例

/******************************************************************************
 * @brief       Description
 * @param[in]   int arg_a : description for input argument
 * @param[out]  int arg_b : description for output argument
 * @return      int : description for return value
 ******************************************************************************/

doxygenだと解析されない. なぜかvscodeだと@briefとかがちゃんとハイライトされる.

画像↓

良い例

/** ***************************************************************************
 * @brief       Description
 * @param[in]   int arg_a : description for input argument
 * @param[out]  int arg_b : description for output argument
 * @return      int : description for return value
 *///**************************************************************************

これだとdoxygenで認識される. 初めの/**の後にスペースがあるのが重要.

ちなみに

/**----------------------------------------------------------------------------
 * @brief       Description
 * @param[in]   int arg_a : description for input argument
 * @param[out]  int arg_b : description for output argument
 * @return      int : description for return value
 *///--------------------------------------------------------------------------

上のようにアスタリスク以外の記号をつかえばdoxygenで認識されるが, vscodeでハイライトされなくなる.

画像↓