スポンサーサイト 

上記の広告は1ヶ月以上更新のないブログに表示されています。
新しい記事を書く事で広告が消せます。

コードを書くときのお話1 

Cプログラミングの秘訣を読みました。 最終更新が1998-09-17ということで結構昔に書かれたものですね。今読んでもかなり参考になるのがすばらしいです。

 

その中に以下のような記述があります。

□必要なコメントをなぜ書けないのか
  …略…
2)必要なコメントであることがわからない。
実はこれが問題なのです。言い換えれば、そこにコメントしておく必要であるという判断ができないのです。または必要と思わなかった、 従ってコメントにしなかった、ということです。その時は頭に入っているが、後でわからなくなるかもしれないことがあれば、 コメントに書くのが望ましいことです。しかし、これは将来忘れるかもしれないということは、それを覚えている間は、 なかなか気付かないことがあります。

私の場合はソースコードだけではわかりようがない制約事項、 つまり開発環境やハードウェアの都合によってそう処理せざるを得なくなった部分にはコメントをつけるようにしてます。

他にもこのようなことが書かれています。

・関数を定義する場合には、それが何をする関数で、 どのような場合にどんな値を戻すのかを書く。
・変数に対するコメントは、その値がどのような場合に、どういう意味を持っているのかを書く。

これって実は実装の話ではなく設計の話ですね。C言語であろうとインターフェース設計が重要なことには変わりありません。

・繰り返し処理(for, whileなど)に対しては、 どのような条件で繰り返すか、または繰り返しを終了するのかを書く。
・条件判断(if, switchなど)に対しては、どのような条件の時に処理が実行されるかを書く。

通常の制御文にコメントが付けられていないのはよく見られます。 通常であるがゆえにコメントを読まなくても内容が理解できてしまうこともその原因でしょう。 このような場合にコメントを付けることの理由は修正時にあると考えられます。 安易な修正を繰り返すとソースコードは当然のように腐っていきます。 記述されているコメントが明確であれば安易な修正を行うことがコメントの内容から乖離していくことになります。 よいコードを書きたいと考えているプログラマーが忙しさに流されてしまうことを止めてくれる効果が期待できると思います。


コメント

コメントの投稿















管理者にだけ表示を許可する

トラックバック

この記事のトラックバックURL
http://ochoo.blog48.fc2.com/tb.php/26-50a152c3

上記広告は1ヶ月以上更新のないブログに表示されています。新しい記事を書くことで広告を消せます。