Rubyエンジニアのみなさん、RDoc書いてますか？「人が書いたRDocは読むけど、自分ではあまり書かない...」という方もいらっしゃるかもしれません。そこで今回はRDocを書くための要点について整理してみました。 RDocの特徴 RDocとは、ソースコードを解析してHTML形式などのドキュメントを出力するツールです。Rubyはもちろん、Cで書かれたライブラリのコードも解析の対象となります。 ドキュメントはモジュール、クラス、メソッドといったプログラムの構造や、コメント部分から生成されます。独立した文書ではなくソースコードから生成されるので、メンテナンスしやすいと言えるでしょう。 インストール ruby1.8系と一緒にインストールされるrdocはバージョンが古いので、gemで新しいものをインストールしておくとよいでしょう。今回はruby1.8.7とrdoc2.3.0を使用します。（最新版は
Ruby の ri ドキュメントに付いて教えてください。 1. ri ドキュメントはrdocコマンドでソースから生成する物ですか？もしそうなら、生成に必要なソースコード内のドキュメントのフォーマットと、riドキュメントの生成方法を教えてください。 2. 生成したriドキュメントをri コマンドで検索できるようにインストールする方法を教えてください。（riドキュメントの有るフォルダへのパス等を設定する必要が有る？） 3. デフォルトの状態(Rubyのインストール直後)でriコマンドで検索する事の出来る、標準ライブラリ内の関数(例:Array.join)のri ドキュメントは（通常）どこに有りますか？ Ruby 1.8.7 MacOSX 10.4.11 です。 よろしくお願いします。
http://rails2u.com/misc/rdocincsearch.user.js 今現在、ruby ライブラリのドキュメントは rdoc で生成するのが一般的です。その中のドキュメント生成の方法の一つのフォーマットに html があり、ライブラリドキュメントの Web の公開形式といえば rdoc が生成した html がスタンダードな感じです。また rubygems をインストールすると使える、ローカルで httpd(webrick) を起動してライブラリドキュメントを閲覧できる gem_server も rdoc の html を利用して表示しています。 しかし、rdoc の出力する html は検索ができないので、たくさんのメソッドから必要なメソッドを探すのに苦労します。そんなわけで rdoc を JavaScript でインクリメンタルサーチできるようにする grease
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
