【リーダブルコードまとめ】第5章:コメントのしかた

どうも、しんじです。今回はリーダブルコードの5章:コメントのやり方について簡単にまとめておきたいと思います。結論から言うとコメントとは書き手の意図を読み手に伝えることです!

【リーダブルコードまとめ】第5章:コメントのしかた

コメントしなくていいこと

コードを読めばすぐわかることはコメントしなくてOKです。

ちなみに訳がわからなくなっているコードに対して行う補助的なコメントもありますが、その場合はコードを修正します。コメントを修正する必要なありません。

コードを書いているときの自分の考えをコメント

何を考えてコードを書いていたのかをコメントするのがいいです。

なぜこのコードが他のやり方ではなく、こうなっているのかを説明します。

またコードの欠陥に対してコメントをして示します。

定数の値にまつわる背景を書きます。

読み手の立場になって何が必要になるか考える

質問されそうなことを想像します。

コードを読んだ人がえっとなるような場所を予想してコメントを書いておく。

ファイルやクラスには全体像のコメントをかく。

読み手が細部にとらわれないようにコードブロックにコメントをつけて要点をまとめる。

以上のような形でコメントをできるとGoodです。

Leave a Reply

Your email address will not be published.

CAPTCHA