よくある複数行のコメントの書き方や例が知りたです。

Question

クラスやヘッダーファイルや関数などにある複数行のコメントでベターなやつは定番のやつの例が知りたいです。自分で適当にやればいいのですが他人の例なども知りたいです。

/************************************
*
************************************/

///////////////// 〇〇　関数
void print();

/*---------------------
*
-----------------------*/

Answer 1

世間ではdoxygenだのいうツールが解釈できる形でのコメントが書かれてることが多いような気がしますが，
そういう予定が特段無いのであれば，まぁ好きにやればよいのではないかな，と．
（個人的に書いているような小さなプログラムでは機械的にリファレンスを生成するようなことも無いでしょうし．）

個々のコメントを過度に装飾する意味は無いと思うので，基本的には普通に

//なんや
//かんや
//どうのこうの

と書いておけば十分だと思います．

個人的に，たまに「区切り」が欲しい所に

///////////////////////////////////

とか書くことはありますが，まぁ余計かな，と．

こんな感じ↓の囲む系もたまに見かけますが，その記述自体が大変面倒そうなので，自分はやらないです．

/***********/
/* comment */
/***********/

Comments

[yumetodo]

大昔と違ってIntelliSenseの支援が十分にあるので、doxygenに従ってコメントを書いとけばあとはどうとでもなるという感はありますよね