はじめに

　この記事は自分が何年も気が付かなかったRubyDoc.infoの便利機能について書きます。

　みなさんは、GitHubで新しいRubyのプロジェクトを見た時に何をしますか？　私はYardでドキュメントを生成してモジュールやクラスの構成をつかもうとします。Yardはプロジェクトの全体構造を把握するのにとても便利です。RubyのGemのYardドキュメントはRubyDoc.info というサイトでオンラインで読めるようになっています。

RubyDoc.info で任意のGithubリポジトリのドキュメントを表示する

　RubyDocでは、GemだけでなくGithubという項目があります。ところが、全部のRubyリポジトリが登録されているわけではなく、一部のレポジトリしか閲覧できません。実は、RubyDock.info には Add Projectボタンがついていて、任意のGithubリポジトリを追加できます！

（ご存知でしたか？　私は今日までこれに気付きませんでした。RubyDoc側が何らかの基準で表示できるGithubのレポジトリを選定していると思い込んでいました！）

Add Projectボタンを押すと、下のように任意のGitHubのリポジトリを追加できる。

　この機能を活用すれば、短時間のうちに任意のGitHubのリポジトリのコードの構成を把握する作業がブラウザで完結できるようになります。

　やったね！

　しばしばRubyはコードは書きやすく読みにくい、と言われます。Rubyは記法に緩さがありますので、確かにそのような側面もあると思います。しかし、YardDoc.infoのような便利なサイトを活用すれば、コードを読むのがかなり楽になるのではないかと思います。

　この記事は以上です。

関連記事