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<目錄名>：設定輸出目錄的目錄名