Route 477(2014-06-06)

■ [prog] コメントの話 去年くらいから仕事のコードでは、privateも含めて全部のメソッドに「何をするメソッドか」という簡単な説明を書くように心がけています。 こういうやつですね。 # このレコードの種類を文字列で返す # 種類が未定義の場合はnilを返す def type_name FOO_NAMES[self.foo_type] end 理由をメモ的にまとめておきます。 1. コメントがあると読む人が助かる バグ修正や機能追加とかで、コードを読む機会というのはけっこうある。そういうときにメソッド単位でコメントがあるとすごく助かる。*1 1行書いておくだけで情報共有のコストが下がるなら、充分良い投資ではないかと思います。 あるいはメソッドを短くして適切なメソッド名を付ければ、コメントは要らないのではと考えたこともあるけど、本当に意図がソースから自明になることって少ないんですよね

[hitode909]

いい話

[mas-higa]

コメント書くよりもテスト書いてる