読者です 読者をやめる 読者になる 読者になる

Natural Software

KinectなどのDepthセンサーを中心に活動しています

極論すると、コメントが無いと読めないコードはダメ

プログラム

このあたりを読んでいて同意することが多かったのでちょっと書いておく。


煽り気味だけど
極論すると、コメントが無いと読めないコードはダメ
言い方を変えると
コメントが無くても読めるソースが良い
というのが自分のスタンス。
当然、全部が全部コメントなしではなく、こういうところは「なぜこう書いたか?」をコメントに残す。

  • わかりづらいところ
  • 意図して冗長にしてるところ
  • 意図して省略してるところ

こういう考え方に至った経緯

  • もともとは一行一行に「なにしてる」をちゃんと(笑)コメントしてた
  • でも、バグを直してるうちに、コードは直すけど、コメントは直さない、という状態になった
  • コードで何してるかわからず、コメントもちぐはぐなので、読んでてストレスになる
  • コードをコメントで語らずにコードで語ればいいじゃん、となった
  • そもそも、C++ やら C# は関数名がそのまま処理の内容になるので、中身のコメントはそもそもいらないはず
  • でも、わかりづらいところはちゃんとコメントにしておく

コードで語ると

  • コード自体を良くしようとして、コードがキレイになる
  • コードがスッキリして全体が見やすくなる
  • 読んでてストレスがない

実際には

まだ完全にコードで語れるほどにキレイなものは書けてないけど、そこにたどり着けるように日々書いてまふ