harupunteの日記： セクションコメント

正式名は判らないのですが「ここからは private method の記述ですよ」「ここからはアクセサの定義ですよ」「メンバ定義ですよ」みたいなセクションごとに付けるデカデカとしたコメント。
各メソッドやドキュメントヘッダじゃないやつ。
久々にプログラム書いてたら、アレの書き方にまた悩まされたり。

個人的に好きなのはコレ。
日記だと等幅じゃないので変になるけれど、コメントをこう囲んでその中でセンタリングする。うん、面倒くさい。だいたい途中から幅の統一がなくなる。

                /****************************************************
                  * COMMENT COMMENT COMMENT
                  ****************************************************/

最近はVisual StudioでのC#が多いので、IDEで /* と入力し始めると勝手に生成されるのにならってコレ。
自動でコメントブロック内に行が追加され続けるのでコメントを閉じる時は一旦それを削除してあげないといけないので面倒くさいです。
（なんかショートカットありそうな気はしますが）

                /*
                  * COMMENT COMMENT COMMENT
                  */

Regionで囲むのもいいですが。
xmlコメントでちゃんと定義されているのかもしれませんがどうなんだろう。他人のコードを漁ってもマチマチな気がします。そもそも書いていないことが多い。
じつはあれ、コボラー的な文化なんだろうか。

んー。というわけで、日曜日の午後は他人のコードを漁ってどんな風にしているのか見学してまわることにします。

^L

[Anonymous Coward]

^L
/*
いまどき印刷するやつはいないだろう。
*/

参考になるかもしれない過去記事

[minet (45149)]

Linus Torvaldsが許せないコメントスタイルとは？ [developers.srad.jp]

さらに、コメントのボックス化を好む人の話を始めるつもりはないとしつつ、ボックス化したコメントはLSDでラリっていれば本当に素晴らしいものだと思えるだろうが、アステリスクの右端が揃っていることを気にする以上に良いことはないと述べている。

エディタ

[Anonymous Coward]

大昔みたいに一色で見た目で区別できない時代なら

/************************************
  * こめんと　　　　　　　　　　　　　*
  ************************************/
  にも一利あったけど、現代ならまさか色分けできないエディタを
使ってる職業プログラマはいないだろう。
＃ なんと「メモ帳を使え」と言われた職場ならあったが..... orz

色分けしてくれるなら、
/*
  * こめんと
  */
で十分わかりやすい。

重要なのは型式よりコメントの中味だ。
「foo に1を入れる」みたいなのが並ぶと地獄の門が開く。