from Rubyコーディング規約
メソッド定義の中にはコメントは記述しない。(コメントが必要だと思われるようなコードにはリファクタリングを行う。)
マジっすか。Ruby の世界は（マテ）割り切りがすごい。でも自分には絶対無理だと思う。コメント書くのが好きだからっつーのもあるかもしんないけど。
[2007-09-11 追記] 中ではなく def の前に RDoc 形式で書くようにすればいい。定義の中に書きたいのはちょっとトリッキーな処理をしているとか、何らかの補足が必要なケース。だから定義中には書かずに済むようなコードを書きましょうということですな。今はそれほどおかしなことではないように感じる。
あとはこの辺は参考にすべきかと思った。
メソッド名は、すべて小文字とし、単語の区切りに`_'を用いる。メソッド名には動詞の原形を使用する。
ファイル名は、すべて小文字とし、単語の区切りに`-'を用いる。また、ファイル中の主な定義クラスの名前を変換したものをファイル名に使用する。(モジュールを名前空間として使用する場合は、ディレクトリを使用して階層構造を表現する。)
これは好きじゃない。まぁ標準のメソッドとの整合性を考えるとしょうがないんだけど。
真偽値を返すメソッド名は、動詞または形容詞に`?'を付け、形容詞に `is_'は付けない。
is_形容詞はなぜ推奨されないのだろう？ 長くなるから？ 自分は ? が出てくると正規表現の方に意識が引きずられるので ? は極力使いたくない。
RDoc は Pdoc よりも素朴だ。
- Pdoc は pod での記述を要求するが、
- RDoc は # でコメントを書くだけでよい。一部 RD の記法も利用できる。
Pdoc は、
sub method
と同じ
=head1 method()?$
を要求する（余計な空白とか入っちゃだめ）が、
RDoc は、
#
# ここのドキュメント
#
def method
各定義前のドキュメントが自動的に method や class のドキュメントとして採用される
長いドキュメントをソース中に埋め込むには pod 形式を採用している Pdoc の方が向いていると思われる。Ruby にも RD があるからその方がよいのではないかと思うが、# を利用した方が使い始めの敷居が低いのは確かだ。
しかしうらめしいのは RDoc と RDTool を併用できないというところであろう。RDTool が Ruby のドキュメントツールの標準として確立されていなかった（事実上の標準だったかもしれないが）たために、せっかくの RD を活かしきれない形になってしまっているように感じる。LL な人たちはあの # を何行も何行も書くのって苦痛じゃないの？ # 形式って自然とコメント書くのが億劫になってよくないと思うのは自分だけなんだろうか？
RDoc の get
本家の sourceforge が Ruby core に取り込まれたので project を inactive にしてしまった。1.6系で RDoc を使いたい場合は
ruby-lang.org の CVSWEB から落とすしかない。
参考
RDoc を使うにはとりあえず
を読むとよい。
しかし
Ruby 1.8 に取り込まれて以降、RDoc は Ruby 1.8 に依存した機能もあるようで、RDoc 使うには 1.8 インストールが最もよい、という結論が出ました。
なんとなく昨日の analog の結果を見たらアクセスがいつもの3倍も！
なんだそりゃーと思ったらどうやら
@nifty：デイリーポータル Z（なんだこの無駄に改行の多いソースは）
経由がいつものアクセスよりちょっと多いくらいにあった。どうもトップページのトピックスに取り上げられたらしいが、その部分だけバックナンバーがないのでどういう紹介だったのかは分からない。集合写真の撮り方のアクセスだけ異常に多いのでここにリンクを張られたのは間違いないけど。remote host のトップは infoweb.ne.jp だったので @nifty 会員てマメだなぁというか、そんな印象を持ってしまった。
しかし待てよ。計算が合わないな。これの影響でもせいぜい 2倍強にしかならないはずなのに。ロボットのクロールが重なったか？
若いウチはあまりモノが見えていない方がいい (CNET 梅田blog)
自分で言うのもなんだが自分は「わけ知り」な方だと思う。調べ物はきらいじゃないし、知識欲もあるし、ツボにハマると完全主義な面が顔をのぞかせてえらいことになる。少なくともただのばかではないつもりだ。しかしその反面、あれこれ情報を集めた結果、推進力を失うこともあるし、欲張りすぎてどうにもならなくなることもある。
まず進むこと。
この難しさを近年ようやく実感している。以前は難しいとすら感じていなかった。つまり進もうともがいていなかったっつーことなんだろうと思う。目標よりも障害の方がはっきり見える、そういう生き方をしていたのだろう。それは今も根本的には変わっていない。悪いクセだ。