コードに対してコメントを書くと実装に関するコメントになる - きしだのHatena

おととい、渋谷JVMというイベントがあって登壇させてもらったんですが、そのあとビール飲んでるときに、ぼくが「コード書く前にコメントだけ書くのいいよね」と言ったあとの返答としてきょんくん(kyon_mm)が言った言葉。 全体としては 「コード先に書いてそのコードに対してテストを書くと実装に対するテストになるし、コードを先に書いてそのコードに対してコメントを書くと実装に対するコメントになる」 という感じ。 ここに至るまでの話もおもしろかったんだけど、ここでは、コメントについて書いてみます。 まず、実装に対するコメントってどういうのかというと、こういうの。 id = findId(name); if(id == -1){ // idが-1だったとき登録 register(name); } いやそれはコード見ればわかるから、ってやつですね。 これは、こうやるとより適切です。 id = findId

[NOV1975]

コメントなしでもわかるコード書け派の人が本当に本人以外の人が完全に意図まで読み取れるコードを書けているか統計的なレベルで気になります。

[iww]

まずコメント文だけガーッと書いてあとからコードで清書する派だけど、エラーの時はどうするとかも一緒に書くので 両方を兼ね備えてることになるな

[terazzo]

つらいときはTODO代わりにコメント先に書くこと多い

[masatomo-m]

ソースコードに書くコメントはビジネスロジックに関することを書くことが多いな。「なぜそういう処理にしているのか」「こういうケースが想定されてないけどそれはなぜ問題ないのか」なんかを書いてる

[takhasegawa]

わかる。 ただし、例えば性能の為など、セオリーを崩さざるを得ない場合は、後から説明コメントでも良いかと思う

[t_nkjm]

というか設計書かかないのかな？コードが全てという文化なら理解できる。

[airj12]

どうしてもコードそのまま系コメントしか書けない人には設計書から対応箇所にコピペしてもらったり

[thesecret3]

このケースだとコメントいらないじゃんという結論を導いたのに、なぜまたコメントつけたがるのだ？/他人のコードの虫取りの経験上コメントはほぼ読まないけど、割と多数の人のソースはコメントなしでも読めるよ。

[John_Kawanishi]

「コード先に書いてそのコードに対してテストを書くと実装に対するテストになるし、コードを先に書いてそのコードに対してコメントを書くと実装に対するコメントになる」

[coolworld]

クソコード書き散らかしてプロジェクト絶賛炎上中の同僚に今日話したばかりの内容でワロタ。

[yaoki_dokidoki]

コメントで意図を書いてからコードを書くという手順の良さを主張している。

[valinst]

全然別件だけど、そもそもコードに日本語があること自体ダサく見えてしまう病にかかっているので極力コメントは入れないで済むようにしてる。どうしてもの時には英語でコメントを入れたいけど、英語力もなさで苦しい

[nrtkbb]

読んだ

[sseze]

社会人になりたての頃に先輩に「何そのやり方」って馬鹿にされたのでやらなくなったけど、世の中いろんな価値観あるってことがわかってちょっとホッとした

[ysync]

ノッてる時に日本語に切り替えたくないｗ

[iakio]

コメントの書き方と同様に、コメントの消し方について考えてみてもいいのかなあと思った。コメントを書く、実装する、あ、このコメント要らないわと思ったら消せばいい

[tg30yen]

自分がそのコードを書いた理由をコメントに書けばいい。

[gologo13]

確かにこれはあり。コメントでなく実装でもメソッドの定義だけ先に作って、中身は後で実装するということを時々する。

[estragon]

「どうやったら意図をあらわすコメントが書けるか」、「コードを書くとき、なんらか意図があってコードを書くわけなんで、その時点でコメント書いておけば意図をあらわすコメントになるだろう」

[deep_one]

コメントは「ブロック」に対してつけてるな。「何がしたいか」という単位。

[hirocueki]

コメントには「これをする」より「なぜこうなっているか」を心がけてる。コメントが腐るというのはもっともで、コードが喋るように読めればいろいろラクになる（けどそれが難しい）

[akulog]

なるほど

[twotiger]

日本人だから日本語の方が分かりやすい。英語のコンピュータ言語よりも。

[n314]

なんかプロジェクトのコメントは信用しない癖がついちゃってる。

[gabari]

むしろこの四行をretryIfNotRegisteredとして抽出すれば関数名が意図を表すのでコメントいらない。先に意図を表す関数スケルトンを書いてから実装する派

[uunfo]

couldRegisterはおかしいだろ…

[ginzi009]

コードに対してコメントを書くと実装に関するコメントになる

[Nagatani]

“いいコメントが書けないという人は、コードを書く前にコメント書いておきましょう。”

[papiro]

先に書いてある事に引きずられてしまう、ということか。そういう発想は無かったな。

[nyop]

なるほどなー。

[koogawa]

コメント先に書いて実装して不要なコメントだけ消す

[PowerEdge]

コードだけでは伝わらない目的のみコメント残すようにする、と。　それがうまくいかない場合は究極的にはコードが間違ってる可能性が高い、ということが分かりやすい。

[pmint]

コメントとコードの重複を考えると、戻り値-1の意味を書くのはNGでDRY. 定義側に書くべき。それが設計書と対応した良いコメントになる。/ 定数使うのは古い。今なら文字列にするところ（だけどJavaでは無理だった）

[hs_hachi]

コメントを先に書くと、無駄なコメント書かないし、リファクタリングしやすいと、いいことだらけなんだよなー

[karasu9113]

日本語のコメントは意外と役に立つ。さっと見渡す時にすぐ目に入るのが日本語だからね。

[oktnzm]

（isRegisteredじゃないのか・・・）

[ch1248]

Test FirstならぬComment Firstか。