コメントアウトの使い分けと、/*** ～ ***/とか// --- を単語登録
PHPをはじめ、多くのプログラミング言語では、コードの説明のためにコメントアウトが用意されています。
PHPやCだと・・・
複数行のコメントアウト。
/* ～ ～ */
1行コメントアウト
// ～
RubyやPythonだと、1行コメントアウトは・・・
# ～
となるのですが、これらのコメントアウトは使い分けたほうがコードが見やすいです。
たとえば、独自に定義した関数やクラスを最初に説明する部分では・・・
/************************************************** 関数名やクラス名 引数やクラスのプロパティ説明 関数やクラスのメソッド説明 **************************************************/
といったかんじで、複数行コメントアウトを用いて、概要説明を目立たせて目に入るようにしますよね。
コードの中のちょっとした説明には、「//」で1行コメント。
また、関数やクラスほど説明するべき項目はないけど、ある程度まとまった一連の処理の部分を見分けるためには、私は・・・・
// -------------------------------------------------- // 一連の処理の説明 // --------------------------------------------------
といったコメントアウトを使ってます。
自分で書いたコードでも、久しぶりに見ると解読不可能になることもありますから、適宜コメントをつけるのは、私には必要だと感じています。
それで、このコメントアウトするときに面倒くさいのが、「*」（アスタリスク）や「-」（ハイフン）を繰り返し入力する手間。
Windowsの場合、「Shift」 + 「ケ, け, *, :」のキーを同時押しで「*」（アスタリスク）を入力できますが、繰り返し入力するためには、数秒間押し続けなければなりません。
ですので、私は・・・
**************************************************
と、
--------------------------------------------------
「*」（アスタリスク）50個と、「-」（ハイフン）50個を単語登録して、変換して入力できるようにしています。
50個は、別に意味はありませんので、お好きな長さで良いと思います。
単語登録の仕方は以下をご参考に。
キーの割り当ては、私の場合そのまんま、デフォルトの「*」、「-」があるキーの位置にしています。
コード中にコメント書くときに繰り返し、「********************」って入力するのがだるい方には、だいぶ楽になるのでおすすめです。
■この記事のトラックバックURL:
http://www.mapee.jp/mpe334/mt-tb.cgi/297
以下のHTMLタグをトラックバック送信元ページ内に挿入して下さい。
※この記事へのリンクがない、また関連のないページからのトラックバックは反映されませんので、ご了承下さい。
