コードにコメントを書く前に考えてみること
複雑なプログラムを書いていると、ついコメントで内容を補足したくなります。
コメントを書くこと自体が悪いわけではないですが、コメントは実装と乖離してしまうと逆に誤解を招いてしまうというデメリットがあります。
できればコメントに頼らずにわかりやすいコードを書きたいものです。
もし、コメントを書きたいな と思ったら、そのコードを別のメソッド・関数に分けることを考えます。
メソッド化・関数化することで、その処理には名前がつきます。(メソッド名・関数名)
そうすることで、実装の中身を見なくてもその処理が何をするのかを、名前からある程度予測することができます。
文章を読むときと一緒ですが、何が書かれているのかを事前に把握できれば読解力が上がります。
コメントを書きたいなと感じたら、まずはその処理をメソッド・関数に分けられるかを考えてみると良いかもしれません。
最近のコメント