読みやすいコード

これからかかわるプロジェクトのコード(Java)読み。書いている人が複数いるだけあっていろんなコードがある。自戒の意味を込めて、読みやすいコードの特徴をまとめてみる。

  • 短い。ひとつのクラスに大量のメソッドを詰め込んだり、ひとつのメソッドに大量のコードを詰め込まないほうがいい
  • コメントアウトされたコードは邪魔。デバッグに便利なのはすんごくわかるけど、邪魔なものは邪魔。
  • 使われていない変数は邪魔。同上。
  • 内部クラスはなるべく使わない。スレッドは別にして、そのまま外部に出せるクラスなら外に出してほしい。
  • 使い方の例があると格段にわかりやすくなる

あと、俺は読むコードを全部プリントアウトして、ペンでいろいろ書き込みながら呼んでいるけど、非効率かしら?モニタより紙のほうが読みやすいんだもん。