コメントの罫線区切り
タイトルコメントや関数のコメントでは説明が複数行にわたるため、その範囲を罫線で区切るとわかりやすくなります。
罫線で区切るとわかりやすい
コメントは/* */で囲まれた範囲なのですが、単純に/*で始めて*/で閉じるだけでは、それがコメントかどうかわかりにくくなることがあります。日本人向けのソースではコメントも日本語で記述するため、半角英数記号だけで書かれたソースコードとの違いは一目瞭然です。しかし、日本語の中に半角英数記号が含まれている場合、複数行にわたるコメントではソースコードとの判別が難しくなる場合もあります。
1～2行で終わる単純なコメントなら、/* */だけでも構いませんが、タイトルコメントや関数の説明など行数の多いコメントの場合には、その範囲がコメントであることを明示するために最初と最後を罫線で区切るとわかりやすくなります。
罫線あれこれ
区切りの罫線には、以下のように - 記号を使うことが多いようです。シンプルで目立ちすぎず、わかりやすいスタイルです。
・一般的な罫線区切り
/* --------------------------
-------------------------- */
-の代わりに = 記号を使う人もいます。少し重い感じがしますが、これは好みの問題でしょう。
・少し目立つ罫線区切り
/* ==========================
以下のような＊記号を使った罫線は、ソースコード以上に目立ってしまうためあまりお奨めできません。事務処理向けの言語であるCOBOLでは＊が1行コメントの記号なので、複数の＊を並べてコメントの区切りにすることがよくあります。また、COBOLでは画面表示やプリントアウトでも罫線に＊記号をよく用います。
しかし、半角英小文字が基本のCでは、-や=に比べて＊の連続は大袈裟なイメージになるため、あまりお奨めはできません。
・目立ちすぎる罫線区切り
/* ***************************
/*で改行して罫線を挿入し、コメントの最後も改行して行頭に*/を記述するというスタイルもあります。前者に比べて行数が増えますが、行頭に終端を示す*/が来るため、コメントの範囲がわかりやすくなります。
・最初と最後に改行を挿入した罫線区切り
/*
----------------------------
----------------------------
*/
|
TOP