Rubyの拡張ライブラリにYARD用のドキュメントを書く方法 - 2012-10-02 - ククログ
はじめに YARDというRuby用のドキュメンテーションツールがあります。この記事ではCで書かれたRubyのライブラリにYARD用のドキュメントを書く方法を紹介します。 YARDはソースコード中にドキュメントを埋め込むタイプのドキュメンテーションツールです。ドキュメントはコメントとして書きます。ドキュメントに@タグ名という記法でメタデータを書けることが特徴1です。YARDに添付されているyardocというコマンドを使うことで、ソースコード中に書いたドキュメントからHTMLのリファレンスマニュアルを作成することができます。 Ruby2はライブラリをRubyでもCでも書けます3。Cでライブラリを書くと、処理を高速化したり、既存のC/C++で書かれたライブラリをRubyから使えるようにできます。例えば、rroonga4はC/C++で書かれた全文検索エンジンライブラリgroongaをRubyから使
RDocとYARDの比較 - 2011-05-11 - ククログ
リファレンスマニュアルの記述方法を検討し、埋め込み方式のドキュメントツールを採用したとします。Rubyで埋め込み方式のドキュメントツールを使うとしたらRDocかYARDになります1。 RDocからYARDへの移行方法につなげたいのでYARDを使う方向で話を進めたいわけですが、その前にRDocとYARDの背景や機能の違いを確認しておきましょう。 RDocの背景 RDocはRuby 1.8.1からRuby本体に標準添付されています。Ruby1.8.1は2003年のクリスマスにリリースされているので、もう7年くらい前になります。Ruby本体や標準添付されているライブラリもRDoc用にドキュメントが書かれていますし、Rubyで標準的なドキュメントツールといえばRDocという存在です。 RDocは2004年くらいまではRuby本体のリポジトリ上で活発に開発されていましたが、それから数年は開発が停滞し
リファレンスマニュアルの記述方法 - 2011-05-05 - ククログ
Rubyではライブラリのリファレンスマニュアル作成のドキュメントツールとしてRDocが標準となっています。これは、古くからあるという理由とRuby本体に標準添付されているという理由からです。しかし、RDocはそれほど活発に開発されていないため、最近のドキュメントツールとして機能不足と言わざるをえません1。どのような機能が足りないのかについては別の機会にします。 数年前からYARD（Yey! A Ruby Documentation Tool）というドキュメントツールが開発されています。YARDはRDocとの互換性を残したまま機能を拡張しているため、RDocからの移行も容易です。実は、YARDは第2回フクオカRuby大賞（SSLの証明書の期限が切れているので警告がでます）に「Improving Documentation in the Ruby Community」というタイトルで応募してい
Route 477(2010-10-04)
■ [ruby] ローカルのgemのドキュメントを見る簡単な方法(2010秋) The 3 Step Guide to Slick Local Documentation for all your Ruby Gems 1. $ gem install yard 2. $ yard server --gems 3. http://localhost:8808/ を開く これは便利。特に、普段--no-rdocしててrdocがない場合でも、動的にrdocを生成してくれるところが。 165 http://d.hatena.ne.jp/willnet/20111006/1317877272 49 http://reader.livedoor.com/reader/ 27 http://blog.willnet.in/entry/20111006/1317877272 14 https://www.
Road To RDoc - はてなかよっ！
(この記事はRuby Advent Calendar jp: 2009の8日目の記事です．前の方はすがまさおさんで，後の方は@Sixeightさんです．) YARD プログラミング言語では，コメントから自動的にドキュメントを生成するツールが大抵用意されていて，RubyにもRDやRDocがあります．RDocは広く使われているので，Rubyistであれば使ったことがあるんじゃないかと思います．そんな中でDataMapperやHamlなど，最近使われるようになってきているのがYARDです．gemが用意されているので $ gem install yardでyardocやyriなどが使えるようになります． yardoc RDocみたいなもので，ソースからドキュメントを生成してくれます．書式は以下のような感じです(スタートガイドから引用)． # Converts the object into tex
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
