院生エンジニアのにっき

  • Change style to Blue
  • Change style to Red
  • Change style to Green
  • Change style to Pink
HOME > ソースコードのコメントについて

ソースコードのコメントについて   2008-02-28

Ajaxian » Every keystroke is a prisoner - a neat commenting trickより。

デバッグの最中は頻繁にコードをコメントアウトしたりコメントを除去したり面倒に思う時があります。

  1. hoge();
  2. hoge2();

は

  1. /*
  2. hoge();
  3. hoge2();
  4. */

でコメントアウトできますが、コメントを元に戻す場合は「/*」と「*/」の両方を除去しないといけません。デバッグの最中に毎回二行修正していては時間の無駄となってしまいます。

しかし、

  1. /*
  2. hoge();
  3. hoge2();
  4. // */

としておくことで

  1. //*    <-「/」を一文字追加
  2. hoge();
  3. hoge2();
  4. // */

とスラッシュ一本を追加するだけでコメントを除去できます。

PHP・C#・JavaScriptなど様々な言語に対応しています。


また、CSSの場合は

  1. .test{
  2.     border:1px solid red;
  3.     /*/
  4.     background-color:blue;
  5.     /**/
  6.     margin:1em;
  7. }

としておくとアスタリスクを一個足すだけで

  1. .test{
  2.     border:1px solid red;
  3.     /**/
  4.     background-color:blue;
  5.     /**/
  6.     margin:1em;
  7. }

とすることが出来ます。

覚えておくとデバッグの手間をちょっと削減できるかもしれません。

コメントを書く
  • たけ(2008 03/03(月) 14:24)
    これは記事の無断転用ですか？ajaxian.comに確認しましたか？
  • 院生エンジニア(2008 03/03(月) 18:45)
    &amp;gt;たけさん
    上記のソースコードでは独自性がないと考えたため転用しました。
    CSSの場合は他の書き方より一般的なソースの方が分かりやすいと考え上記のようになっています。
    hoge(); hoge2();のソースに関しては一般的な「ノウハウ」をajaxian.comは公開していると考えたので、自分の解釈を交えて記載しました。
    この点に関して問題はないかと考えます。