ruby-文档生成器rdoc使用

通常使用rdoc命令来为ruby程序生成文档

eg:

 rdoc test.rb

如果要对整个项目的rb文件生成文档只需在rdoc命令后不带文件名

eg:

rdoc

如果有类和方法不想生成doc

eg:

def no_doc #:nodoc:

end

或

class NoDocClass #:nodoc:all

部分注释不想生成doc

#--

#该行不会生成doc

#++

#该行会生成doc

rdoc命令：

--all：rdoc默认只将共有方法生成doc，使用--all会将所有方法生成doc

--fmt <xml,yaml,chm,pdf>:用指定格式生成文档

--help：

--inline-source:将代码显示在文档中

--main<name>:设置主索引页面的名字

--one-file:将rdoc所有文档内容放在一个文件中

--op<目录名>：设置输出目录的目录名