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

コメントブロックに囲いを付けると認識されない. <a name='more'></a> doxygenでの関数のコメントブロックは以下のような感じ. ```c /** * @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をやっているのでテキストだけでわかりやすいのも大事. ということで **悪い例** ```c /****************************************************************************** * @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`とかがちゃんとハイライトされる. 画像↓ <img border="0" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEhzHcPtm1EtBax0TV8KxptlmNh33Hmrblf5YUPP79XiTLOiKVC1sfG06eOciHD-NTRYp7PgGzN9U2xhPle8f0DRhUhXD3U73ab76djOc01Zt9YbGmf_kn89t_2EjuUgNCOgTDHo-bY7tEsP/s1600/doxygen_comment_1.png" width="80%" /> **良い例** ```c /** *************************************************************************** * @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で認識される. 初めの`/**`の後にスペースがあるのが重要. ちなみに ```c /**---------------------------------------------------------------------------- * @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でハイライトされなくなる. 画像↓ <img border="0" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEitNhBS33jpHupmpylpoaGjGVssaDF8ZOhj5kA5ovo93nr8bbQ6h4LZQ2rCrDcBqt05G_q3-5revKkgHHn6DyWhkbbF4tH_XpNU72RZsi4uPabz1cnawSt2ZsPXsS6Dl78s-MiA22SOBLLW/s1600/doxygen_comment_2.png" width="80%" />