2012年8月19日日曜日

コメントのつけかた

先日偶然みつけた10年前に私が書いたプログラム(こちらを参照)をみていて思ったのですが、コメントのつけかたがまったくなっていません。

プログラム初心者のうちは、「なぜコメントをつけるのか」といった基本的なことが案外理解できていないようです。
「プログラムを読みやすくするためにコメントをつける」とだけ理解していても、実際はそれができていないのです。

たとえば、10年前に私が書いたプログラムには、こんなところにもコメントがふられていました。

'変数iに1を加算する
i = i + 1

変数iに1を加算することなど、コードをみればすぐわかります。
このような行にコメントをふるのは、まったくのナンセンスです。
当時の私は「とにかくコメントをつけることが大事」だと勘違いしていたようで、このような無駄なコメントがほとんどの行にふられており、これではいたずらにソースコードの行数を増やすだけです。

コメントは、コードをみただけではわかりづらいと感じた箇所にふるのです。
たとえば、関数やメソッドの定義まえにその関数やメソッドがどのような処理を行うかを記述することにより、その内容をソースコード上で読み解く必要がなくなります。
その際、
  • どのようなパラメータを指定する必要があるのか(データ型が存在するプログラミング言語の場合は、パラメータのデータ型も含む)
  • その関数もしくはメソッドの戻り値は何か(データ型が存在するプログラミング言語の場合は、戻り値のデータ型も含む)
の2点は必ずコメントに記述します。


0 件のコメント:

コメントを投稿