2010年7月16日金曜日

Rubyのまつもとさん (Matz)によるコーディング規約的な啓示

コーディング規約というほどカッチリしたものではないが、味わい深い。

Matzにっき(2004-10-06)
コーディングスタンダード

社内メーリングリストでRubyのコーディングスタンダードの話題が持ち上がる。 個人的には「自分で勝手に決めて」という感じなのだが、 まあ、私のスタイルを参考にしたい人もいるだろうということで、 まとめてみた。

だいたいはShugoさんのRubyコーディング規約と同じ。
でもRuby以外でも役に立つことがちらほら。
以下抜粋。
  • ライブラリファイルの末尾には if __FILE__ ==
    $0 で囲んで テストケース(かサンプルプログラム)を書いておくとよい。
  • 自明なことはコメントしない。なぜなら本当に大切なコメント が埋没してしまうから。
  • 「未来の自分が混乱しそう」と思ったことは躊躇せずコメント する。そうでなければコメントはあまり必要ない。
  • 「本当に必要だ」と感じた時以外はメソッドは20行以内に抑え る(数はどうでもよい、目安に過ぎない)。例外は巨大なcase文
    を含むディスパッチコードくらいか。

0 件のコメント:

ブログ アーカイブ

カテゴリー