変数名、関数名とコメントでは表現する内容が違う - きしだのHatena

先日Twitterにこんなことを書いた。 なにやってるかはコード見ればわかる。なにやろうとしてるかはコードみてもわからんからコメント書け。 そうしたところ、変数・関数(メソッド)に適切な名前をつければ改めてコメントの必要はないんじゃないかという指摘をうけた。 そんで、しばらくやりとりをしたのだけど、その中で結論として変数名・関数名やコメントで表現する内容が違うということに気づいた。 やはり、変数名・関数名には、その機能を表すものをつけることになる。一方で、コメントにソースコードで表されていることを書くのは意味がない。 if(a==0){ //aが0のとき } のようなコメントは、意味のないコメントとしてよく例にあげられる。 if(a==0){ //パラメータが渡されなかったとき } のように、判定の意図を書くべきだ。 ここで、変数をaじゃなくてまともな名前にすればいいんじゃないかという話で

[kuwalab]

コメント

[rryu]

パラメータ0個の判定の真の意図はエラー処理やデフォルト動作を行うといったものになるはずで、「パラメータが渡されなかったとき」というのはまだまだ意味の無いコメントなのだと思う。

[raimon49]

例示されているパターンではbooleanの変数で表現するのが好みなんだけど、この辺はチームの方針に拠りけりかなという気はする。

[hiro_y]

「関数はコンテキストに依存しないように機能を抜きだして機能の名前をつける、変数名は作業性とのバランスをとってなるべく意図をあらわす、あらわしきれない意図はコメントで書く」

[takc923]

なるほど

[h_sabakan]

あー、此はよく分かる。物の本には変数名、関数名共に意図することが理解しやすいものに、とある。素直に従ったらタイプ量が増えたけど、今時のIDEはインテリセンスが賢くなっているのでありかと。

[natsutan]

よくある。＞「再利用しやすい関数をつくろうとすると、意図が抜かれるということだ。」

[masaru_b_cl]

whatとか前提はコメント、howは変数名などで、かなぁ？