メッセージ
2005年10月06日の記事
2005/10/06(木)rdocを使ってみる
2005/10/06 12:00
何も考えずにコメント書いても通るのはけっこう好み。
今の作り方はこう。
rdoc -o <出力パス> -c shift_jis -T kilmer *.rb
- Tはテンプレートでkilmerの方が若干見やすいが、出力しない項目もあるのでテンプレートを指定しない場合と見比べて好みのものを選べばいいだろう。
とりあえず目についたところで定数(constants)を出力しないのを直した。というかほとんど単なるコピペ。
>diff kilmer.rb.orig kilmer.rb 310a311,330 > IF:constants > <table cellpadding=5 width="100%"> > <tr><td class="tablesubtitle">Constants</td></tr> > </table> > <div class="name-list"> > <table summary="Constants"> > START:constants > <tr class="top-aligned-row context-row"> > <td class="method-name">%name%</td> > <td>=</td> > <td class="context-item-value">%value%</td> > IF:desc > <td width="3em"> </td> > <td class="context-item-desc">ﾞsc%</td> > ENDIF:desc > </tr> > END:constants > </table> > </div> > ENDIF:constants(すんませんKShikiのタグ置換に引っかかって見られません。ソース表示なら…)
ところで私はよくこういうコードを書いてしまうのだが、
class square
def initialize(w, h)
@width = w
@height = h
end
def get_area
return @width * @height
end
end
rdocだとこの場合のインスタンス変数は出力してくれない。それが当然のような気もするし、出力して欲しい気もする。
<rdoc書き方>
http://www.kmc.gr.jp/~ohai/rdoc.ja.html