閉じる


<<最初から読む

2 / 8ページ

YARD


ドキュメンテーションツール

RDoc互換

rubydoc.info使われている

yriについては割愛


使い方


yardoc

rake yard
RDoc(SDoc)との違い。


Markdownも使える(割愛)

リアルタイムジェネレーター

サーバー


yard server

yard server --gems
bundle exec yard server --gems

RDoc(SDoc)との違い。
タグ付け。

@param [String] name name of ...
@param [Array<Numeric>] indices indices of ...
@param [#read] raw_data File or other IO
@param [Hash] options options
@option options [true, false] :strict parse strictly when true passed
@return [MyStruct]
def parse(name, indices, raw_data = '', options = {})
    :
    :
end


読者登録

北市真さんの更新情報・新作情報をメールで受取りますか?(読者登録について