コメントのサンプル

Last-modified: 2006-12-20 (水) 16:33:05

What?

  • プログラム内でのコメントの記法について、ある程度決まったパターンがあれば非常に便利だと思った。とりあえずまとめてみます。
  • 対象はC/C++言語。でもまあ、考え方としては大体どんな言語にでも適応できる。

想定する使い方

  • 以下のようなサンプルを、ショートカットキーで呼び出せるようなクリップボードソフト等(私はCLCLを使ってます)に登録しておく。
  • 簡単にコメントサンプルが呼び出せると、なんとなーく使いたくなるもので、結果的にコードの可読性が上がる。
  • みんなしあわせ!
  • あと、自分の環境じゃないところでプログラミングしなくちゃならなくなったとき。ここにまとめておけば、コピペで使えるよなあ、なんて考えも。

  • 一行の字数は80字を基本とする。理由は特にない。
  • 区切り線
    //------------------------------------------------------------------------------
    //==============================================================================
    //******************************************************************************

  • 関数
    //------------------------------------------------------------------------------
    // Name     :
    // Function :
    // Argument :
    // Return   :
    // Comment  :
    //------------------------------------------------------------------------------