RDocとYARDの比較 - 2011-05-11 - ククログ
リファレンスマニュアルの記述方法を検討し、埋め込み方式のドキュメントツールを採用したとします。Rubyで埋め込み方式のドキュメントツールを使うとしたらRDocかYARDになります1。 RDocからYARDへの移行方法につなげたいのでYARDを使う方向で話を進めたいわけですが、その前にRDocとYARDの背景や機能の違いを確認しておきましょう。 RDocの背景 RDocはRuby 1.8.1からRuby本体に標準添付されています。Ruby1.8.1は2003年のクリスマスにリリースされているので、もう7年くらい前になります。Ruby本体や標準添付されているライブラリもRDoc用にドキュメントが書かれていますし、Rubyで標準的なドキュメントツールといえばRDocという存在です。 RDocは2004年くらいまではRuby本体のリポジトリ上で活発に開発されていましたが、それから数年は開発が停滞し
メソッド検索のできるRDoc -- Hanna - yuumi3のお仕事日記
最近、そこかしこでJavascriptを使ってローカルで検索できるRDocを見かけるようになってきました。Ruby on Railsのように膨大な数のメソッドがあるソフトウェアのドキュメントを調べるのに検索機能は必須ですね。 そこで、検索のある RDoc を作る Hanna を使ってみました。 上の画像のように、メソッドのフレームの上部の入力欄にキーワードを入力すると、キーワードを含むメソッド名のみが表示されるようになります。 Hanna を使った Ruby on Rails ドキュメントの作り方 Hannaの使い方は http://github.com/mislav/hanna/tree/master に詳しく書かれていますが、ローカルに Ruby on Rails ドキュメントを作る場合は。 % sudo gem install hanna % rails rails_doc % cd
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
