模組 RDoc

RDoc 透過解析原始碼並擷取類別、模組、方法、包含和需求的定義，為 Ruby 原始碼檔案產生文件。它會將這些與緊接在前的註解區塊中包含的選用文件關聯，然後使用輸出格式化器呈現結果。

如要了解使用 RDoc 編寫或產生文件的簡單介紹，請參閱 README。

路線圖¶ ↑

如果您認為在 RDoc 中發現錯誤，請參閱 CONTRIBUTING 中的錯誤

如果您想使用 RDoc 為您的 Ruby 原始碼檔案建立文件，請參閱 RDoc::Markup，並參閱 rdoc --help 以了解命令列用法。

如果您想設定預設標記格式，請參閱 RDoc::Markup 中的支援格式

如果您想將 rdoc 組態儲存在您的 gem 中（例如預設標記格式），請參閱 RDoc::Options 中的儲存選項

如果您想為 Ruby 檔案撰寫文件，請參閱 RDoc::Parser::Ruby

如果您想為以 C 編寫的擴充撰寫文件，請參閱 RDoc::Parser::C

如果您想使用 rake 產生文件，請參閱 RDoc::Task。

如果您想以程式方式驅動 RDoc，請參閱 RDoc::RDoc。

如果您想使用函式庫將文字區塊格式化為 HTML 或其他格式，請參閱 RDoc::Markup。

如果您想建立 RDoc 外掛程式，例如產生器或指令處理常式，請參閱 RDoc::RDoc。

如果您想撰寫自己的輸出產生器，請參閱 RDoc::Generator。

如果您想要了解 RDoc 的工作原理，請參閱 CONTRIBUTING 中的 Bugs

致謝¶ ↑

RDoc 目前由 Eric Hodel <[email protected]> 維護。

Dave Thomas <[email protected]> 是 RDoc 的原始作者。

rdoc/parse.rb 中的 Ruby 解析器在很大程度上依賴於 Nippon Rational Inc 的 Keiju ISHITSUKA 的傑出工作，他為 irb 和 rtags 套件製作了 Ruby 解析器。

常數

ATTR_MODIFIERS: RDoc 屬性的修改器
CLASS_MODIFIERS: RDoc 類別的修改器
CONSTANT_MODIFIERS: RDoc 常數的修改器
DOT_DOC_FILENAME: 包含要處理的檔案描述的 dotfile 名稱
GENERAL_MODIFIERS: 一般 RDoc 修改器
KNOWN_CLASSES: Ruby 的內建類別、模組和例外
METHOD_MODIFIERS: RDoc 方法的修改器
VERSION: 您使用的 RDoc 版本
VISIBILITIES: Method 可見性

公開類別方法

home() 按一下以切換原始碼

搜尋並傳回設定的目錄。

$HOME/.rdoc 目錄（如果存在）。
rdoc 目錄（如果已設定），在 XDG_DATA_HOME 環境變數指定的路徑下。
$HOME/.local/share/rdoc 目錄。

# File lib/rdoc.rb, line 134
def self.home
  rdoc_dir = begin
              File.expand_path('~/.rdoc')
            rescue ArgumentError
            end

  if File.directory?(rdoc_dir)
    rdoc_dir
  else
    require 'fileutils'
    begin
      # XDG
      xdg_data_home = ENV["XDG_DATA_HOME"] || File.join(File.expand_path("~"), '.local', 'share')
      unless File.exist?(xdg_data_home)
        FileUtils.mkdir_p xdg_data_home
      end
      File.join xdg_data_home, "rdoc"
    rescue Errno::EACCES
    end
  end
end

load_yaml() 按一下以切換原始碼

載入最佳可用的 YAML 函式庫。

# File lib/rdoc.rb, line 107
def self.load_yaml
  begin
    gem 'psych'
  rescue NameError => e # --disable-gems
    raise unless e.name == :gem
  rescue Gem::LoadError
  end

  begin
    require 'psych'
  rescue ::LoadError
  ensure
    require 'yaml'
  end
end