第1部 表面上の改善 ~コメントの付け方Vol.1~
今日はコメントの付け方に関する内容を読んだので、過去に自分がつけたコメントを題材に分析してみた。
コードを見てわかる内容をコメントにしない
確かに。コードを見ればわかるんだからコメントにする意味がない。昔、プログラミングを学び始めた頃、1行1行にコメントしているんじゃないかってぐらいコメントしたことがあった。見づらくて仕方ない。。。コメントは、コードの意図を伝えたい箇所に必要な分だけ書くことを意識しよう。(多分、今でも無駄なコメントを書いている気がするから)
コメントを直すのではなくコードを直す
今まで「コメントがわかりにくいから直そう」としていた。そうではなく、そんなコードが悪いのだという考えは自分になかった。
「コメントが不要なコード=見ただけで伝わるコード=リーダブルコード」
なるほど、自分の目標に一致している。コードの見直しを意識していこう。
この記事が気に入ったらサポートをしてみませんか?