Readable Code ? [雑談]
今から遡ること 3 年ほど前、Readable Code という書籍が出版され話題になったことがある。プログラムのロジックではなく、表現力を向上させるためのノウハウのような、この分野ではちょっと変わった内容の書籍。要は、読みやすいコードを書くことに注力していくことで、コードを共有することが容易になり、しいては、他人にコードの内容を説明するという、ある意味無駄な作業を回避するための手法のあれこれ。
当時は、主にコードを書く人たちに取り上げられ、話題になって行ったようだけど、今では、会社ぐるみで(強制ではないけど)実践を促すようなところも出てきているようだ。それ自体は悪いことではないと思うし、読みやすいコードを書いてくれるなら、そりゃ、ありがたいとは思うんだけど...。
コードに埋め込まれるコメントについては、いろいろなところで議論されてきている。コメントは多ければいいというわけではないし、全くないからと言ってそれで出荷停止になるようなものでもない。必要なところに必要なだけ埋め込むのが最良ではあるけど、その閾値には個人差が(相当)あるみたい。
左記の Readable Code にも、コメントを埋める際の指針のようなものが示されているのだけど、実践となるとなかなか上手くいかないのが現状らしい。さらに厄介なのが、書に例として挙げられてるコメントをそのまま埋める輩が出てきた。
// このメソッドは重い。繰り返し呼び出されると、パフォーマンスに影響が出る可能性がある
このコメントを免罪符のように扱うようになると、コード品質は地に落ちるのではないかと危惧する。アルゴリズムの改善を検討する前に、逃げ口上を用意しているようなものだし。
その後、このコメントが添えられたメソッドは、識者の手によってパフォーマンスを気にしなくても問題のないレベルに書き換えられた。所要時間、30 分ほどだったとか。
そして、オリジナルのコードは全てコメントアウトされた上に、、、一言、「晒されたくなかったら、真似するな」
コメント 0