タグ

rdocに関するkeyesberryのブックマーク (6)

  • RSpecのMatcher一覧をRSpecのrdocから参照する - miyohide's blog

    先日、RSpecのMatcher一覧をまとめられているサイトを紹介しましたが、RSpecのrdocに詳細が書かれているよということを知りました。 が、gemのインストール時に、no-rdocを指定しているしなぁ・・・と思っていたら、こんなブログ記事を見つけました。 ローカルgemのrdocみるなら gem server より yard server --gems やり方は簡単で。 1.yard gemをインストール % gem install yard 2.yard server --gemsで起動 % yard server --gems 3.ブラウザでhttp://localhost:8808/docs/rspec-expectations/RSpec/Matchers するとRSpecのMatcher一覧が表示されます。 これだと必要最低限のrdocしか作られず、便利便利。

    RSpecのMatcher一覧をRSpecのrdocから参照する - miyohide's blog
  • Ruby/Railsのコードを読むにはroccoとrdefsが便利:Rails Hub情報局:エンジニアライフ

    新年明けましておめでとうございます。今年こそRuby/Railsをやってみようという人もいるかと思います。ここではRubyのコードを読むのに便利なツールを2つほどご紹介したいと思います。 ドキュメント生成ツールのRD、RDoc、SDoc ソースコードに埋め込んだコメントを、そのままドキュメントとして抽出するツールがRubyにはいろいろあります。いちばん古くからあるのは、RD(Ruby Document Format)と呼ばれるもので、Markdownなどと同様に構造を記述できます。 現在、Rubyに標準添付されているのはRDocです。RubyのソースコードからHTMLCSSJavaScriptを吐き出して、ブラウザで閲覧しやすくしてれます。もう1つ、RDocに似たものにSDocがあります。Sはsearchableのことで、ブラウザ上でクラスやメソッド名をインクリメンタル検索できるのが特

    Ruby/Railsのコードを読むにはroccoとrdefsが便利:Rails Hub情報局:エンジニアライフ
  • YARD - A Ruby Documentation Tool

    What Is YARD? YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions. Above is a highlight of the some of YARD's notable features. And of course YARD comes with muc

  • Tender Lovemaking » Blog Archive » RDoc on your iPad

    Oh snap! I haven’t posted here in a long time. My day job and my night jobs have been keeping me too busy! Hopefully I’ll have more time to blog in the future. I have a bunch of ideas, I just need to find the time to write! Anyway, let’s talk RDoc, iPad, and epub! I like documentation. I especially like consuming documentation. I thought it would be neat if I could read documentation on my iPad. A

  • いますぐ始める RDoc によるドキュメント生成 - WebOS Goodies

    先日公開した Ruby 用 JSON クラスを RubyForge にスニペットとして登録しました。使い方も書かないで登録しても意味がないので、この機会に今まで興味がありながら手が出せなかった RDoc を使ってみました。これがもう驚くほど簡単で、なんで今まで使わなかったのかー!!と後悔しきりです。そんなわけで、私のようにわず嫌いをしている方に向けて、「30 分で始める RDoc」を目標に(あくまで目標^^;)使い始めの手引きを書いてみました。まだ RDoc をご利用でない方、挑戦してみてはいかがでしょうか。 なお、すでに Ruby 一式がインストール済みで、最低限の Ruby の知識があることを前提にしていますので、あらかじめご了承ください。 まず最初に、 RDoc について軽くご紹介しておきます。すでにご存知の方は読み飛ばしてください。 RDoc は Ruby 専用のドキュメント生成

  • RDoc による自動ドキュメント生成

    RDoc とは? 概要 インストール サンプル Ruby スクリプト作成 RDoc によるドキュメント生成 RDoc の便利な機能を使ってみる RDoc ドキュメントのサンプル 参考資料 RDoc とは? Ruby Documentation System (RDoc) とは, Ruby で書かれたソースコードから ドキュメントを自動生成する, Ruby 体に付属する標準ライブラリの1つです. RDoc は Ruby ソースコードを解析し, クラス, モジュール, メソッドの定義 を抜き出し, include や require に関して解釈します. そしてこれらの内容 とその直前に書かれたコメントを併合し, HTML ドキュメントを出力しま す. 詳しくは参考資料 1,2 を参照ください. 概要 以下では, まず RDoc のインストールを行います. そして Ruby で簡単なクラ ス

  • 1