Rubyでドキュメントを書く RDoc vs YARD vs TomDoc - { Blog not Updated }Rubyでドキュメント書くときは標準ライブラリで入ってるRDocを使う人が多いかもしれませんが他にもドキュメントのフォーマットがあるのでいろいろ比較してみた。 下記コードの詳細は https://github.com/natsumesou/ruby-doc こちらを御覧ください。 RDoc RDocは特にフォーマットというのが無いので良くも悪くも自由にかける(String)は自分で勝手につけただけで生成されたドキュメントでも文章として扱われるだけ。 # 人間を表すクラス class Person # - first_name - 名前 attr_reader :first_name # - last_name - 苗字 attr_reader :last_name # - gender - 性別 attr_reader :gender # - age - 年齢 attr_reader :a
