メソッド検索のできる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
RDoc Documentation
RDOC - Ruby Documentation System このパッケージはRdocとSimpleMarkupというふたつのコンポーネントを含んでいます。 RdocとはRubyのソースファイルに対するドキュメントを生成するアプリケーションです。 JavaDocと同様に、ソースを解析し、クラス、モジュール、メソッドの定義を抜き出して きます(include,requireもです)。そしてこれらの内容とその直前に書かれた コメントを併合し、ドキュメントを出力します(現在はHTMLしか出力できませんが 、この部分は取り替え可能にできています)。Markupとはプレーンテキストを 様々なフォーマットに変換するためのライブラリです。Rdocによってメソッドや クラスに関するドキュメントを生成するとき、コメント部を変換するため に使われます。 ロードマップ RdocでRubyのソースファイルに対
Rubyコーディング規約
はじめに 本文書は、Rubyによりコーディングを行う際の規約について述べる。 実際のプロジェクトに適用する際には、このコーディング規約をカスタ マイズして用いることを推奨する。 ソースコードの整形 インデント プログラムを読みやすくするため、インデントを適宜行う。インデント 幅は2とする。また、インデントにはスペースのみを使用し、タブは使用 しない。(環境によりタブ幅が異なるため。) 例: if x > 0 if y > 0 puts "x > 0 && y > 0" end end 一行の桁数 一行の桁数は最大80桁までとする。 空行 複数のクラスの区切には空行を挿入する。 例: class Foo ... end class Bar ... end 誤った例: class Foo ... end class Bar ... end また、クラス内の各構成要素の区切にも空行を挿入する。
RDoc Documentation
Class and Module Index ARGF ArgumentError Array BasicObject Binding Class ClosedQueueError Comparable Complex Continuation Data Dir ENV EOFError Encoding Encoding::CompatibilityError Encoding::Converter Encoding::ConverterNotFoundError Encoding::InvalidByteSequenceError Encoding::UndefinedConversionError EncodingError Enumerable Enumerator Enumerator::ArithmeticSequence Enumerator::Chain Enumerato
Ruby-Doc.org: Documenting the Ruby Language
Current Ruby Releases These are the complete API documents for base classes, modules, and included libraries in the current stables releases of Ruby. Complete API docs for Ruby 3.2.2 Complete API docs for Ruby 3.1.4 Complete API docs for Ruby 3.0.6 Complete API docs for Ruby 2.7.8 Complete API docs for Ruby 3.3.0.preview2 Older Ruby Releases Complete 3.2.1 Complete 3.2.0 Complete 3.1.2 3.1.1 Core
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Peak Obsession
