パーフェクトRuby (PERFECT SERIES 6) 作者: Rubyサポーターズ,すがわらまさのり,寺田玄太郎,三村益隆,近藤宇智朗,橋立友宏,関口亮一出版社/メーカー: 技術評論社発売日: 2013/08/10メディア: 大型本この商品を含むブログ (22件) を見る 14章より。 rdoc の代わりとして yard を試したことはあるのですが 知らないコマンドがありました。 gem install すると以下の実行ファイルが install されます。 yard, yardoc, yri yardoc は html で document を出力してくれてありがたやーな訳なんですが yard にはいろいろサブコマンドが定義されており 中でも yard diff が強力であることを知りました。 （他にも server とか graph とかあります） やってみる $ yard di
Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? YARD - A Ruby Documentation Tool http://yardoc.org/ Rails/Rubyドキュメントをキレイに生成するYARD、早見表付き！ - 酒と泪とRubyとRailsと http://morizyun.github.io/blog/yard-rails-ruby-gem-document-html/ RDoc- Document Generator for Ruby Source http://rdoc.sourceforge.net/ library rdoc http://doc.ruby
Rubyでドキュメント書くときは標準ライブラリで入ってるRDocを使う人が多いかもしれませんが他にもドキュメントのフォーマットがあるのでいろいろ比較してみた。 下記コードの詳細は https://github.com/natsumesou/ruby-doc こちらを御覧ください。 RDoc RDocは特にフォーマットというのが無いので良くも悪くも自由にかける(String)は自分で勝手につけただけで生成されたドキュメントでも文章として扱われるだけ。 # 人間を表すクラス class Person # - first_name - 名前 attr_reader :first_name # - last_name - 苗字 attr_reader :last_name # - gender - 性別 attr_reader :gender # - age - 年齢 attr_reader :a
はじめに YARDというRuby用のドキュメンテーションツールがあります。この記事ではCで書かれたRubyのライブラリにYARD用のドキュメントを書く方法を紹介します。 YARDはソースコード中にドキュメントを埋め込むタイプのドキュメンテーションツールです。ドキュメントはコメントとして書きます。ドキュメントに@タグ名という記法でメタデータを書けることが特徴1です。YARDに添付されているyardocというコマンドを使うことで、ソースコード中に書いたドキュメントからHTMLのリファレンスマニュアルを作成することができます。 Ruby2はライブラリをRubyでもCでも書けます3。Cでライブラリを書くと、処理を高速化したり、既存のC/C++で書かれたライブラリをRubyから使えるようにできます。例えば、rroonga4はC/C++で書かれた全文検索エンジンライブラリgroongaをRubyから使
ぬかいわし、タレカツ、鶏の半身揚げ、そして笹団子。新潟を平らげる２泊３日 今回の旅の目的地は新潟。新潟には申し訳ないのだが、自発的に決めた目的地ではない。ＪＲ東日本の「どこかにビューーン！」という行き先ガチャサービスにより決定されたのだ。新潟といえば酒どころ米どころ。ちょうど新米の季節だ。どんとこい。古町エリアに宿を取っ…
FlexやRuby on Railsなどで使い方とかを自分が後でわかるようにメモしておくブログ。最近はFlex系に飽きてます。 [ruby]rdocは捨て去られてYARDになった[gem] 皆さんはrubyやrailsのドキュメントをどのように作成されていますか？ rdocだとjavadocみたいなことができないーーーということに悩んでいませんか？ そんなときにはこれをお試しください。 yardとは rdocの進化版 すごく綺麗なリファレンスが作成できます 参考URLとしてyardの凄さを表したのがこのページです。 => Gemリファレンス Gemに登録されているライブラリをyardで表示しています。 インストール 今回利用したのは0.6.4です。なおrdocの生成を勝手にしますが、失敗します。 gem install yard ドキュメント生成方法 RAILS等のルートディレクトリで実行
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
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
