今日のビックリ

from Rubyコーディング規約

メソッド定義の中にはコメントは記述しない。(コメントが必要だと思われるようなコードにはリファクタリングを行う。)

マジっすか。Ruby の世界は(マテ)割り切りがすごい。でも自分には絶対無理だと思う。コメント書くのが好きだからっつーのもあるかもしんないけど。

[2007-09-11 追記] 中ではなく def の前に RDoc 形式で書くようにすればいい。定義の中に書きたいのはちょっとトリッキーな処理をしているとか、何らかの補足が必要なケース。だから定義中には書かずに済むようなコードを書きましょうということですな。今はそれほどおかしなことではないように感じる。

あとはこの辺は参考にすべきかと思った。

メソッド名は、すべて小文字とし、単語の区切りに`_'を用いる。メソッド名には動詞の原形を使用する。

ファイル名は、すべて小文字とし、単語の区切りに`-'を用いる。また、ファイル中の主な定義クラスの名前を変換したものをファイル名に使用する。(モジュールを名前空間として使用する場合は、ディレクトリを使用して階層構造を表現する。)

これは好きじゃない。まぁ標準のメソッドとの整合性を考えるとしょうがないんだけど。

真偽値を返すメソッド名は、動詞または形容詞に`?'を付け、形容詞に `is_'は付けない。

is_形容詞はなぜ推奨されないのだろう? 長くなるから? 自分は ? が出てくると正規表現の方に意識が引きずられるので ? は極力使いたくない。

More