記号の説明
- size -> Integer の「-> Integer」って何?
-
size メソッドは整数を返すという意味です。
- Kernel.#require の .# って何?
-
「.#」はモジュール関数であることを表します。「Kernel.#require」は「Kernel のモジュール関数である require 」という意味です。
- String#size の # って何?
-
「#」はインスタンスメソッドであることを表します。
- Dir.chdir の . って何?
-
「.」はクラスメソッドであることを表します。
- p a #=> 1 の #=> って何?
-
「#=>」は標準出力に出力されるということを表しています。「p a #=> 1 」は「p a」を実行すると標準出力に「1」が出力されるという意味です。
返り値の型の詳細
返り値の型の仕様は以下のようになっています。
- 真偽値を返す場合は「bool」です
- 返り値が不定の場合は、「-> ()」です
- 任意の型を返す場合は 「object」 です
- 配列を返す場合は 「[クラス名]」 か 「Array」 です
- 代入式の場合には省略されます
複数の型の値を返すときは "|" を使って記述されています。
例# String または String の配列を返す
CGI#[](name) -> String | [String]
x オブジェクトと nil で成功・失敗を表す場合は「x | nil」が使われています。
文法欄の読み方
言語仕様のページには、「文法」という見出しの付いたコードブロックで、その構文の文法が示されています。ここでは、プログラム中には現れない、文法を説明するための記号(メタ記号)について説明します。
例えば クラス/メソッドの定義/クラス定義 のクラス定義の文法は次のように書かれています。
文法class 識別子 [`<' superclass ]
式..
end
[ ]-
省略可能な要素であることを表します。上の例では
\<' superclass` (つまりスーパークラスの指定)を省略できることを示しています。 `x'-
バッククォートと引用符ではさまれたものは、その文字自体(リテラルのトークン)を表します。上の例の
\<'は、<` という文字そのものが必要であることを示しています。 .. / ...-
直前の要素が 0 回以上繰り返されることを表します。上の例の
式..は、本体に式が 0 個以上並ぶことを示しています。この記法は、 演算子式/範囲式 の範囲演算子../...や、引数移譲の...記法(def foo(...); bar(...); end)とは無関係です。
検索
各ページの上部にある検索ボックスでは、表示しているバージョンのリファレンス内を検索できます。
全バージョンを横断して検索したい場合は
の検索ページを利用してください。
参考
このマニュアルの読み方をもっとやさしく学びたい方は、伊藤淳一 著『Rubyの公式リファレンスが読めるようになる本』 (web book、無料) も参考にしてください。
お問い合わせ
間違いを見付けた場合は
へお願いします。
それ以外の意見なども
へお願いします。
GitHub の使い方は
を参照してください。