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から使
yard graphでクラス図を生成しちゃえ☆（ゝω・）vｷｬﾋﾟ - すがブロ
yardは単なるドキュメンテーションライブラリではない!! みなさん Yard はご存知ですか。ご存知ですよね。 RDocとか、Rubyでソースコードに書くドキュメンテーションツールでYARD(http://yardoc.org/)ってありますよね。 プロジェクトのルートでyard docってやるとrdocで実行するのと同じようにドキュメントが生成されるのですが、それだけで満足しては行けないんだよ。 yard helpって打つとサブコマンドがいろいろ出てくるんだよ。 % yard help Usage: yard <command> [options] Commands: config Views or edits current global configuration diff Returns the object diff of two gems or .yardoc files d
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
