トップ «前の日記(2008-06-14) 最新 次の日記(2008-06-18)» 編集

2008-06-15 [長年日記]

_ RDoc::usage がやっぱりあった。けど。

先日 pragger を眺めていて

またドキュメントのためにコードを丸ごと文字列で持つのは RD とか RDoc をうまく使えば避けられるんじゃないかと思ったけど、よく分かんないorz

なんてことを書いていたけど Pod と同じ発想で探したらあった。

require 'rdoc/usage'
RDoc::usage( [[STATUS,] SECTION_NAME, ...] )

するだけで、起動したスクリプトに書かれている RDoc コメントを表示することができる。

んが。

この rdoc/usage.rb の中身を見ると、gets( file ) 以降は private なので任意のファイルの usage を生成することはできないようになっている。うーむ。まぁ RDoc module をゴニョゴニョして plugin の usage を表示させる方法もなくはないけど、そこまでコスト掛けるなら現状の pragger のように妥協案として

## コメント

行を抽出して表示するってのはアリなのかもなぁ。現状でも一応 rdoc コマンドでドキュメントを生成することはできるんだし。

Tags: Ruby Pragger