Ruby | RDocの編集機能

概要

RDocの編集機能

詳細

RDocの編集機能について。

サンプルコード

# encoding : utf-8

=begin rdoc
Hogeモジュール
  内容1
    内容1-1
  内容2
    内容2-1

_italic_
  _italic_

*bold*
  *bold*

<tt>type writer font</tt>
  <tt>type writer font</tt>

Hoge::Hoge
  Hoge::Hoge

Hoge::Hoge#hoge
  Hoge::Hoge#hoge

RDoc Reference:http://rdoc.sourceforge.net/
  RDoc Reference:http://rdoc.sourceforge.net/

[label] detail
  [label] detail

label:: detail
  label:: detail

= level1
  = level1

== level2
  == level2

=== level3
  === level3

=end
module Hoge
  class Hoge
    def hoge # :yields:hige
      puts "hoge"
      yield "hige"
    end

    def no_doc # :nodoc:
      puts "no_doc"
    end

    private
    def private_method # :doc:
      puts "private_method"
    end
  end
end

Hoge::Hoge.new.hoge {|hige|puts hige}

RDoc