コメントレスコーディングのススメ

コメントを書かないでコーディングしましょう。

コメントを書かないでコーディングしましょうと言うことは、プログラムの解読をコメントに頼らない。読みやすさをコメントに頼らない。という事で、読みやすいコーディングを心がけましょうと言うことです。

個人的な経験上から言うと、コメントが多いプログラム程、読みにくい構成になっています。

変数名、関数名、クラス名がむやみに短縮されていたりして、何も連想できなかったりします。

あと、保守されていないコメントは、ミスリードを誘います。叙述トリックです。(違う)

というわけで、コメントレスコーディングを奨めるわけです。

もれなく、以下の特典が付いてきます。

自分に・・・

・構成力がつく。

・文章力がつく。

・その他(考えてください)

プログラムが・・・

・読みやすくなる。

・保守性が高くなる。

・その他(考えてください)

です。

ちなみに、コメントレスコーディングをするに当たって気をつけなくてはいけないのは以下の点。

・変数名、関数名、クラス名を省略しない。

・それぞれが持っている役割を書く。

・名前は長くなっても良い。

・名前が長すぎると思ったら、役割を持ちすぎているので分解する。

・マジックナンバーを使わない。

・文章を書くようにプログラムする。

これらが守られなかった場合、悪夢をみます。

って、別にコメントレスじゃなくても、当然気をつけるべき点ですね。

まぁ、モノは試し、とりあえず、コメントレスでコーディングしてみて、読みにくいと思ったら、要所要所コメントを付ければいいのではないでしょうか。

と、ちょっと端折り気味。

Share