Rubyを学ぶ際によく使われるのがリファレンスサイトです。またRubyでプログラム開発に従事されている方でも、Rubyで使える全てのメソッドを覚えているとは限りません。そのためリファレンスサイトを参照しながら仕事をしている方もいます。
しかしリファレンスサイトを読んでもよく解らない、という方もいるでしょう。そのような方にRubyのリファレンスサイトの活用方法について紹介します。
リファレンスサイトの概要
Rubyに限らずプログラミングの仕事をするなら、手元に利用するプログラミング言語のリファレンスマニュアルを用意して、いつでも引けるようにしておきたいものです。とはいえ今はインターネットで検索すれば大抵のことを調べられます。そしてRubyの文法やメソッドの使い方を紹介したリファレンスサイトも利用可能です。
まずはリファレンスサイトとはどんなものなのかを紹介します。
そもそもリファレンスとは
リファレンスサイトの「リファレンス」とは、英語の「reference」が語源のIT用語です。なお英語の「reference」とは「参照」や「照合」といった意味の言葉ですが、IT用語の「リファレンス」は、英語の「reference manual」(リファレンスマニュアル)と同じ意味でつかわれます。
そしてリファレンスマニュアルとは、プログラミング言語の文法や関数、メソッドなどを網羅しており、辞書のように使える説明書のことです。もし、調べたいメソッドがあったら、リファレンスマニュアルをまるで辞書のように引いて、そのメソッドを説明したページをチェックします。
リファレンスマニュアルは本だけ?
マニュアルや辞書と聞いて分厚い本を思い浮かべる方もいるでしょう。以前のエンジニアは、自分が使うプログラミング言語のリファレンスマニュアルの分厚い本を仕事で使う机の上に置いて、いつでも引けるように用意していました。
しかし、Rubyのリファレンスマニュアルは本だけではありません。Rubyの文法やメソッドの使い方を解説したリファレンスサイトが用意されています。
なお本のリファレンスマニュアルは、調べたいメソッドを引くためにページをめくらなければならず、手間がかかっていました。しかしリファレンスサイトを活用すれば、簡単に検索することが可能です。他もも関連する項目のリンクがあるなど、リファレンスマニュアルよりも便利に使えます。
リファレンスサイトの問題点
日頃からRubyのプログラミングを仕事にしている方にとって、リファレンスサイトはとても便利なWebサイトです。しかしメリットばかりではありません。
特にRubyの公式サイトにあるリファレンスサイトは専門用語が多く使われており、掲載されている例も理解しにくいなど、Rubyを学習し始めた方にとっては読んでも難しくて理解できないかもしれません。そのため公式サイトよりも初心者にやさしいリファレンスサイトなどの併用も検討してください。
Rubyの公式リファレンスサイト
Rubyはオープンソースのスクリプト言語で、誰でも無料で利用できるうえ、Rubyを利用するエンジニア同志のコミュニティも活発です。そのようなRubyの公式サイトで公開されているリファレンスマニュアルは、コミュニティに参加している有志が作成したものです。
次からRubyのそのよなうな公式リファレンスサイトの利用方法を案内します。
公式リファレンスサイトのURL
Rubyの公式サイトには、最新版のリリース案内の他にRubyのインストールの仕方やライブラリの探し方など、Rubyを学ぶ方にとって役に立つ情報が掲載されています。そして、特に重要な情報がリファレンスマニュアルです。
リファレンスマニュアルを使う場合は、まずRubyの公式サイトを検索し、それを表示してください。続いてメニューの「ドキュメント」をクリックします。すると、マニュアルやチュートリアルんどのドキュメントのリンクをまとめたページが表示されます。
このページから自分が使うRubyのバージョンに合わせて、リファレンスマニュアルを参照してください。
Rubyの公式サイト
Web検索を利用する
先ほど紹介したように公式サイトのドキュメントのページから公式リファレンスサイトを利用できます。しかし、ここから特定のメソッドの使い方を調べるのは不便です。メソッドの使い方を調べたい場合はGoogleなどのWeb検索を利用します。
なおRubyの使い方を紹介しているWebページは公式リファレンスサイトだけではありません。そのため多くのWebページがヒットするでしょう。公式リファレンスサイトのページは、「リファレンスマニュアル」が記載されているので、他のサイトと区別できます。
Google検索でヒットした公式リファレンスサイトのページの例
Array#each (Ruby 3.1 リファレンスマニュアル)
クラスから探す
Rubyのプログラムで使われる変数のほとんどがオブジェクトであり、その基になったクラスで定義されたメソッドを利用できます。そのためメソッドの使い方を調べたい場合は、その基になったクラスから調べると、メソッドの使い方が理解できます。
ただし、Rubyで使えるクラスは階層構造になっており、クラスが違うオブジェクトでも、上の階層が同じ場合は、そのクラスに定義された同じメソッドを利用できます。公式リファレンスサイトでは、継承したメソッドとクラス独自のメソッドとが解るように書かれているので、クラスから調べた場合、その違いを確認できます。
公式リファレンスサイトの問題点と対策
Rubyの使い方を学ぶなら、Rubyの仕様どおりに書かれている公式リファレンスサイトをおすすめします。しかし、初心者にとって公式リファレンスサイトが使いやすいとは言えません。読んでも内容を理解できない、といったこともあります。
次に公式リファレンスサイトの問題点と対策について紹介します。
専門用語が多い
公式リファレンスサイトを執筆しているのは、Rubyのコミュニティに所属するベテランエンジニアの有志です。そのため書かれている内容は信頼できます。しかし、ベテランエンジニアにとって身近な用語が初心者にも解るとは限りません。
特にオブジェクト指向などの難しい概念を指す専門用語をそのまま使っているケースが多く、そのような概念を理解していない初心者にとっては、何が書いてあるか解りません。他にも同じようなプログラミングで使われる専門用語が使われています。
公式リファレンスサイトを読む場合は、そのような専門用語が多く使われている考えてください。
例が不親切
公式リファレンスサイトには、多くの例が紹介されています。そしてそのような例はシンプルな記述で特徴をよく表現したものばかりです。しかし、その例の説明が無いので、中には何をやっているのか理解しにくいものもあります。
そのためRubyの初心者が公式リファレンスサイトの例を見ても、そのままでは自分が書こうとしているプログラムで利用できないケースも多いので注意してください。
他のサイトの活用も
このように学習を始めたばかりの方や初心者の方は、公式リファレンスサイトを利用するのは難しいかもしれません。
とはいえRubyの使い方を紹介した日本語のWebサイトは幾つもあります。中には辞書のように引けるリファレンスサイトもあり、より読み易く、例も解りやすいものが掲載されているサイトもあります。公式リファレンスサイトと同時に、このようなもっと読み易い他のサイトも活用してください。
まとめ
これまで紹介したようにRubyの公式サイトにはリファレンスマニュアルが用意されており、公式リファレンスサイトと呼ばれています。Rubyの仕様に合わせて書かれた正式なマニュアルなので、Rubyを学習する方やRubyの初心者の方は、ぜひ活用してください。
ただし書かれている内容が難しいかもしれません。なおインターネットにはRubyの使い方を紹介しているサイトが幾つもあります。ぜひ、公式リファレンスサイトと同時にそのようなサイトも合わせて利用してください。