Rubyで定義したメソッドに戻り値のYARD用ドキュメントを書く方法 - 2013-04-18 - ククログ

はじめに YARDというRuby用のドキュメンテーションツールがあります。これまでに2回、YARD用のドキュメントの書き方についてククログで紹介しました。 Rubyの拡張ライブラリにYARD用のドキュメントを書く方法 Rubyで定義したメソッドの引数についてのドキュメントをYARD用に書く方法 今回は前回の「Rubyで定義したメソッドの引数についてのドキュメントをYARD用に書く方法」という記事の続きで、Rubyで定義したメソッドに戻り値のYARD用ドキュメントを書く方法を紹介します。 まず、戻り値のYARD用ドキュメントを書くための@returnタグ1について説明したあと、実際にドキュメントを書くRubyのコードを示します。その後、実際に@returnタグを使ってドキュメントを書き、YARDのコマンドを使ってHTMLのリファレンスマニュアルを作成します。 なお、YARDについてや、YAR

[mat_aki]

Rubyで定義したメソッドに戻り値のYARD用ドキュメントを書く方法 - ククログ(2013-04-18) -