Some Days You Get the Bear

IT系エンジニアの、日々の気づきや考えたこと。

コメントも「抽象度」なのだ

qiita.com

例年この時期には、新入社員が入ってきて
「コメント書きなさいよー」って話をするわけですが、でも
そのうちなれてきたら、
「コメントなくても読めるコードを書けよー」と言いたいです!
 
最初のうちは "コードを説明するためのコメント" を書いてしまうもの。
これでは 単なる"直訳" なのです。
コードで書いてることを2度も書いて、わざわざ説明する必要はないのです。
 
そうではなくってほしいのは、
「こうやって実装したけれど、これはこういうことをやるためなんだよ、
こういうことをやりたいんだよ」、という情報。
"ひとつ抽象度の高い" 情報なのです。

結局、コードだけだと、具体的な実装そのものしか見えなくて、
「そもそもの設計」が見えづらくなってしまう、それを補うためのコメントが欲しいのです。

となると、抽象度を上げるということで、
やっぱり「意味のある部品」にして「読めばわかる名前」をつけておけば
コメントなくても読めるじゃん、ということになるかと思うのです。
 
上記の Qiita をきっかけに、
コメントの書き方のことをググってみたら、けっこういろいろ書いてあったし。
Qiita の同記事のコメントにもいろいろ書いてあったし。
けっこうひとそれぞれの考え方があるもんだなー、と思いました。
自分の考えを押し付けないほうがいいことなのかもしれませんね。
 
seichi23.hatenablog.comseichi23.hatenablog.com
qiita.com