類別 RDoc::MarkupReference

類別 RDoc::MarkupReference 僅存在於為 RDoc 標記提供適當的參考文件首頁。

在此類別中定義的所有物件（類別、模組、方法、別名、屬性和常數）僅用於說明 RDoc 標記，沒有其他合法用途。

RDoc 標記參考¶ ↑

注意事項

此參考中的範例為 Ruby 程式碼和註解；請注意與其他來源（例如 C 程式碼和註解）的某些差異。
顯示呈現的 HTML 輸出的範例會在區塊引號中顯示該輸出

呈現的 HTML

一些東西

RDoc 生成的文件是由下列項目衍生和控制的

某些定義之前的單行或多行註解；請參閱註解中的標記。
追蹤註解中的 RDoc 指令（與程式碼在同一行）；請參閱 :nodoc:、:doc: 和 :notnew:。
單行註解中的 RDoc 指令；請參閱其他指令。
Ruby 程式碼本身（但非 C 程式碼）；請參閱從 Ruby 程式碼衍生的文件。

註解中的標記¶ ↑

註解中標記的處理方式會根據檔案類型而有所不同

.rb（Ruby 程式碼檔案）：從 Ruby 註解中解析標記。
.c（C 程式碼檔案）：從 C 註解中解析標記。
.rdoc（RDoc 文字檔案）：從整個檔案中解析標記。

與 Ruby 類別、模組、方法、別名、常數或屬性相關聯的註解會成為該定義物件的文件。

在 Ruby 檔案中，該註解會緊接在物件定義之前。
在 C 檔案中，該註解會緊接在實作方法的函式之前，或緊接在物件定義之前。

在 Ruby 或 C 檔案中，RDoc 會忽略未出現在物件定義之前的註解。

在 RDoc 檔案中，文字不會與任何程式碼物件相關聯，但可能會（視文件建置方式而定）成為一個獨立的頁面。

此頁面上的幾乎所有範例都類似 RDoc；也就是說，它們沒有 Ruby # 或 C /* ... */ 等註解標記。

邊界¶ ↑

在多行註解中，RDoc 會尋找註解的自然左邊界，該邊界會成為註解的基本邊界，並且是註解的初始目前邊界。

目前邊界可以變更，例如在清單中。

區塊¶ ↑

將 RDoc 標記輸入視為一系列各種類型的區塊會很方便（詳細資訊請參閱連結）

段落：一般段落。
逐字文字區塊：要逐字呈現的文字區塊。
程式碼區塊：包含 Ruby 程式碼的逐字文字區塊，要以程式碼突顯方式呈現。
區塊引號：較長的引文段落，要以縮排方式呈現，而不是使用引號。
清單：項目清單、編號清單、字母清單或標籤清單的項目。
標題：章節標題。
水平規則：在呈現的頁面上的一條線。
指令：各種呈現的特殊指示。
文字標記：以特殊方式呈現的文字。

關於區塊

除了段落，區塊以其縮排或不尋常的開頭或嵌入字元區分。
任何區塊都可以獨立出現（即，未巢狀在另一個區塊中）；有些區塊可以巢狀，如下所述。

段落¶ ↑

段落包含一行或多行非空白的普通文字，每一行都從目前的邊界開始。

注意：這裡，普通文字是指未識別為縮排或不尋常的開頭或嵌入字元的文字。請參閱下方。

段落以一行或多行空白行分隔。

範例輸入

\RDoc produces HTML and command-line documentation for Ruby projects.
\RDoc includes the rdoc and ri tools for generating and displaying
documentation from the command-line.

You'll love it.

呈現的 HTML

RDoc 為 Ruby 專案產生 HTML 和命令列文件。RDoc 包含 rdoc 和 ri 工具，用於從命令列產生和顯示文件。

你會喜歡它的。

段落可能包含巢狀區塊，包括

逐字文字區塊¶ ↑

縮排比目前邊界更遠的文字會變成逐字文字區塊（或程式碼區塊，下述）。在呈現的 HTML 中，此類文字

已縮排。
具有對比的背景顏色。

逐字文字區塊在第一行從目前邊界開始時結束。

範例輸入

This is not verbatim text.

  This is verbatim text.
    Whitespace is honored.     # See?
      Whitespace is honored.     # See?

  This is still the same verbatim text block.

This is not verbatim text.

呈現的 HTML

這不是逐字文字。

This is verbatim text.
  Whitespace is honored.     # See?
    Whitespace is honored.     # See?

This is still the same verbatim text block.

這不是逐字文字。

逐字文字區塊可能不包含任何類型的巢狀區塊——它是逐字的。

程式碼區塊¶ ↑

逐字文字的一個特例是程式碼區塊，它僅是 RDoc 識別為 Ruby 程式碼的逐字文字

在呈現的 HTML 中，程式碼區塊

已縮排。
具有對比的背景顏色。
具有語法突顯。

範例輸入

Consider this method:

  def foo(name = '', value = 0)
    @name = name      # Whitespace is still honored.
    @value = value
  end

呈現的 HTML

考慮此方法

def foo(name = '', value = 0)
  @name = name      # Whitespace is still honored.
  @value = value
end

專業提示：如果縮排的 Ruby 程式碼沒有突顯，則它可能包含語法錯誤。

程式碼區塊可能不包含任何類型的巢狀區塊 – 它是逐字的。

區塊引號¶ ↑

您可以使用字元 >>>（未縮排），後接縮排文字，將文字視為區塊引號

範例輸入

Here's a block quote:
.
  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer
  commodo quam iaculis massa posuere, dictum fringilla justo pulvinar.
  Quisque turpis erat, pharetra eu dui at, sollicitudin accumsan nulla.

  Aenean congue ligula eu ligula molestie, eu pellentesque purus
  faucibus. In id leo non ligula condimentum lobortis. Duis vestibulum,
  diam in pellentesque aliquet, mi tellus placerat sapien, id euismod
  purus magna ut tortor.

呈現的 HTML

以下是區塊引號

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer commodo quam iaculis massa posuere, dictum fringilla justo pulvinar. Quisque turpis erat, pharetra eu dui at, sollicitudin accumsan nulla.

Aenean congue ligula eu ligula molestie, eu pellentesque purus faucibus. In id leo non ligula condimentum lobortis. Duis vestibulum, diam in pellentesque aliquet, mi tellus placerat sapien, id euismod purus magna ut tortor.

請注意，與逐字文字不同，單一換行不會被保留，但雙換行會在區塊引號中開始新段落。

區塊引號可能包含巢狀區塊，包括

清單¶ ↑

每種類型的清單項目都以特殊開頭標示

項目符號清單項目：以連字號或星號開頭。
編號清單項目：以數字和句點開頭。
字母清單項目：以字母和句點開頭。
標籤清單項目：以下列其中一項開頭
- 方括號文字。
- 一個字詞後接兩個冒號。

清單以清單項目開頭，並持續進行，即使跨越空白行，只要在相同縮排層級找到相同類型的清單項目。

新清單會將目前的邊界向內重置。在該邊界對齊的額外文字行是持續清單項目的一部分。

清單項目可以持續在與第一行對齊的額外行上。請參閱以下範例。

清單項目可能包含巢狀區塊，包括

項目符號清單¶ ↑

項目符號清單項目以連字號或星號開頭。

範例輸入

- An item.
- Another.
- An item spanning
  multiple lines.

* Yet another.
- Last one.

呈現的 HTML

一個項目。

另一個。

一個跨越多行的項目。

再一個。

最後一個。

編號清單¶ ↑

編號清單項目以數字和句號開頭。

項目會自動重新編號。

範例輸入

100. An item.
10. Another.
1. An item spanning
   multiple lines.

1. Yet another.
1000. Last one.

呈現的 HTML

一個項目。

另一個。

一個跨越多行的項目。

再一個。

最後一個。

字母清單¶ ↑

字母清單項目以字母和句號開頭。

項目會自動「重新編號」。

範例輸入

z. An item.
y. Another.
x. An item spanning
   multiple lines.

x. Yet another.
a. Last one.

呈現的 HTML

一個項目。

另一個。

再一個。

最後一個。

標籤清單¶ ↑

標籤清單項目以下列其中一項開頭

方括弧文字：標籤和文字分兩行。
字詞後接兩個冒號：標籤和文字在同一行。

範例輸入

[foo] An item.
bat:: Another.
[bag] An item spanning
      multiple lines.

[bar baz] Yet another.
bam:: Last one.

呈現的 HTML

foo

一個項目。

bat

另一個。

bag

一個跨越多行的項目。

bar baz

再一個。

bam

最後一個。

標題¶ ↑

標題以最多六個等號開頭，後接標題文字。這些等號和標題文字之間的空白可有可無。

範例

= Section 1
== Section 1.1
=== Section 1.1.1
=== Section 1.1.2
== Section 1.2
= Section 2
= Foo
== Bar
=== Baz
==== Bam
===== Bat
====== Bad
============Still a Heading (Level 6)
\== Not a Heading

標題只能包含一種巢狀區塊

文字標記.

水平規則¶ ↑

水平規則由一行組成，該行包含三個或更多連字號，且沒有其他內容。

範例輸入

---
--- Not a horizontal rule.

-- Also not a horizontal rule.
---

呈現的 HTML

— 不是水平規則。

– 也不是水平規則。

指令¶ ↑

允許或禁止文件指令¶ ↑

# :stopdoc:
- 出現在單獨一行上。
- 指定 RDoc 應略過標記，直到下一個 :startdoc: 指令或檔案結尾。
# :startdoc:
- 出現在單獨一行上。
- 指定 RDoc 應繼續分析標記。
# :enddoc:
- 出現在單獨一行上。
- 指定 RDoc 應略過標記至檔案結尾，不論其他指令為何。
# :nodoc:
- 附加至定義類別、模組、方法、別名、常數或屬性的程式碼行。
- 指定不應記錄已定義的物件。
- 對於 C 程式碼中的方法定義，必須置於實作之前
```
/* :nodoc: */
static VALUE
some_method(VALUE self)
{
    return self;
}
```
  請注意，此指令在方法定義位置完全無效。例如，
```
/* :nodoc: */
rb_define_method(cMyClass, "do_something", something_func, 0);
```
  上述註解只是一個註解，與 RDoc 無關。因此，do_something 方法將報告為「未記錄」，除非該方法或函式在其他地方有記錄。
- 在 C 程式碼中的常數定義中，這個指令無法運作，因為沒有常數的「實作」位置。
# :nodoc: all:
- 附加在定義類別或模組的程式碼行中。
- 指定類別或模組不應記錄。然而，預設情況下，巢狀類別或模組會記錄。
# :doc:
- 附加至定義類別、模組、方法、別名、常數或屬性的程式碼行。
- 指定已定義的物件應記錄，即使在其他情況下不應記錄。
# :notnew:（別名為 :not_new: 和 :not-new:）
- 附加在定義實例方法 initialize 的程式碼行中。
- 指定單例方法 new 不應記錄。預設情況下，Ruby 模擬對應的單例方法 new，RDoc 會將其包含在記錄中。請注意，實例方法 initialize 是私有的，因此預設情況下不會記錄。

對於 Ruby 程式碼，但對於其他 RDoc 來源則不然，:stopdoc: 和 :startdoc: 有簡寫。

# Documented.
#--
# Not documented.
#++
# Documented.

對於 C 程式碼，任何指令 :startdoc:、:stopdoc: 和 :enddoc: 都可能出現在獨立註解中

/* :startdoc: */
/* :stopdoc: */
/* :enddoc: */

指定 RDoc 來源格式的指令¶ ↑

# :markup: type:
- 出現在單獨一行上。
- 指定 RDoc 輸入的格式；參數 type 是 markdown、rd、rdoc、tomdoc 之一。

HTML 輸出的指令¶ ↑

# :title: text:
- 出現在單獨一行上。
- 指定 HTML 輸出的標題。
# :main: filename:
- 出現在單獨一行上。
- 指定要首先顯示的 HTML 檔案。

`Method` 記錄的指令¶ ↑

# :call-seq:
- 出現在單獨一行上。
- 指定要在 HTML 中報告的呼叫順序，覆寫程式碼中的實際呼叫順序。請參閱方法 call_seq_directive。
請注意，RDoc 可以為 Ruby 編碼的方法建立呼叫順序，但無法為其他語言建立。如果您想包含，您可能需要透過明確提供 :call-seq: 指令來覆寫它
- 回傳類型，不會自動推論。
- 多個呼叫順序。
對於 C 程式碼，指令可能出現在獨立註解中。
# :args: arg_names（別名為 :arg:）
- 出現在單獨一行上。
- 指定要回報在 HTML 中的參數，覆寫程式碼中的實際參數。請參閱方法 args_directive。
# :yields: arg_names（別名為 :yield:）
- 出現在單獨一行上。
- 指定要回報在 HTML 中的 yield 參數，覆寫程式碼中的實際 yield。請參閱方法 yields_directive。

組織文件說明的指令¶ ↑

預設情況下，RDoc 會將

單例方法依字母順序分組。
實例方法及其別名依字母順序分組。
屬性和其別名依字母順序分組。

您可以使用指令來修改這些行為。

# :section: section_title:
- 出現在單獨一行上。
- 指定後續方法應分組到具有給定 section_title 的區段，或在未給定標題的情況下分組到預設區段。此指令會持續有效，直到給出另一個此類指令，但可能會被指令 :category: 暫時覆寫。請參閱下方。
包含此指令的註解區塊
- 必須與下一項的文件說明以空白行分隔。
- 可以在指令前面有一行或多行。這些行將會移除，以及任何與它們相符的尾行。這些行在視覺上可能會有幫助。
- 未被移除的文字行會成為區段的描述文字。
範例
```
# ----------------------------------------
# :section: My Section
# This is the section that I wrote.
# See it glisten in the noon-day sun.
# ----------------------------------------

##
# Comment for some_method
def some_method
  # ...
end
```
您可以使用指令 :category: 來暫時覆寫目前的區段。
# :category: section_title:
- 出現在單獨一行上。
- 指定只有一個後續方法要包含在給定的區段中，或在未給定標題的情況下包含在預設區段中。後續方法應分組到目前的區段。

包含 `File` 的指令¶ ↑

# :include: filepath:
- 出現在單獨一行上。
- 指定給定檔案的內容應包含在這個點。檔案內容會被移位，與指令開頭的冒號具有相同的縮排。
  
  檔案會在使用 --include 命令列選項給出的目錄中搜尋，或預設在目前目錄中搜尋。
對於 C 程式碼，指令可能會出現在獨立的註解中

文字標記¶ ↑

文字標記是會影響 HTML 呈現的元文字

字型：斜體、粗體、單字型。
字元轉換：版權、商標、特定標點符號。
連結。
跳脫：將文字標記為「非標記」。

字體標記¶ ↑

字體標記可以指定文字以斜體、粗體或等寬字體呈現。

字體標記只能包含一種巢狀區塊

更多字體標記：斜體、粗體、等寬字體。

斜體¶ ↑

文字可以透過 HTML 標籤  或  標示為斜體。

範例輸入

<i>Italicized words</i> in a paragraph.

.
  <i>Italicized words in a block quote</i>.

- <i>Italicized words</i> in a list item.

====== <i>Italicized words</i> in a Heading

<i>Italicized passage containing *bold* and +monofont+.</i>

呈現的 HTML

斜體字 出現在段落中。

斜體字出現在區塊引用中.

斜體字 出現在清單項目中。

斜體字 出現在標題中¶ ↑

包含粗體和 等寬字體 的斜體段落。

單一字詞可以透過簡寫標示為斜體：加上前後底線。

範例輸入

_Italic_ in a paragraph.

.
  _Italic_ in a block quote.

- _Italic_ in a list item.

====== _Italic_ in a Heading

呈現的 HTML

斜體出現在段落中。

斜體出現在區塊引用中。

斜體出現在清單項目中。

斜體出現在標題中¶ ↑

粗體¶ ↑

文字可以透過 HTML 標籤  標示為粗體。

範例輸入

<b>Bold words</b> in a paragraph.

.
  <b>Bold words</b> in a block quote.

- <b>Bold words</b> in a list item.

====== <b>Bold words</b> in a Heading

<b>Bold passage containing _italics_ and +monofont+.</b>

呈現的 HTML

粗體字 出現在段落中。

粗體字 出現在區塊引用中。

粗體字 出現在清單項目中。

粗體字 出現在標題中¶ ↑

包含斜體和 等寬字體 的粗體段落。

單一字詞可以透過簡寫標示為粗體：加上前後星號。

範例輸入

*Bold* in a paragraph.

.
  *Bold* in a block quote.

- *Bold* in a list item.

===== *Bold* in a Heading

呈現的 HTML

粗體出現在段落中。

粗體出現在區塊引用中。

粗體出現在清單項目中。

粗體出現在標題中¶ ↑

等寬字體¶ ↑

文字可以透過 HTML 標籤 <tt> 或 <code> 標示為等寬字體（有時稱為「打字機字體」）。

範例輸入

<tt>Monofont words</tt> in a paragraph.

.
  <tt>Monofont words</tt> in a block quote.

- <tt>Monofont words</tt> in a list item.

====== <tt>Monofont words</tt> in heading

<tt>Monofont passage containing _italics_ and *bold*.</tt>

呈現的 HTML

等寬字體字詞 出現在段落中。

等寬字體字詞 出現在區塊引用中。

等寬字體字詞 出現在清單項目中。

等寬字體字詞 出現在標題中¶ ↑

包含斜體和粗體的等寬字體段落。

單一字詞可以透過簡寫標示為等寬字體：加上前後加號。

範例輸入

+Monofont+ in a paragraph.

.
  +Monofont+ in a block quote.

- +Monofont+ in a list item.

====== +Monofont+ in a Heading

呈現的 HTML

等寬字體 出現在段落中。

等寬字體 出現在區塊引用中。

清單項目中的單字型。

標題中的單字型¶ ↑

字元轉換¶ ↑

某些字元組合可能會轉換為特殊字元；是否轉換取決於目前編碼中是否有該特殊字元。

(c) 轉換為 ©（版權字元）；必須是小寫。
(r) 轉換為 ®（註冊商標字元）；必須是小寫。
'foo' 轉換為 ‘foo’（智慧型單引號）。
"foo" 轉換為 “foo”（智慧型雙引號）。
foo ... bar 轉換為 foo … bar（1 個字元省略號）。
foo -- bar 轉換為 foo – bar（1 個字元連字號）。
foo --- bar 轉換為 foo — bar（1 個字元破折號）。

連結¶ ↑

RDoc 文字中的某些字串會轉換為連結。可以在任何此類連結前加上反斜線來抑制連結。本節說明如何連結到各種目標。

類別

頁面上：DummyClass 連結到 DummyClass。
頁面外：RDoc::Alias 連結到 RDoc::Alias。

模組

頁面上：DummyModule 連結到 DummyModule。
頁面外：RDoc 連結到 RDoc。

常數

頁面上：DUMMY_CONSTANT 連結到 DUMMY_CONSTANT。
頁面外：RDoc::Text::MARKUP_FORMAT 連結到 RDoc::Text::MARKUP_FORMAT。

單例 Method

頁面上：::dummy_singleton_method 連結到 ::dummy_singleton_method。
頁面外RDoc::TokenStream::to_html 連結到 RDoc::TokenStream::to_html。

注意：有時 RDoc 沒有連結到名稱僅包含特殊字元的 method。請檢查您預期的連結是否實際存在。如果沒有，您需要建立明確的連結；請參閱下方。

專業提示：任何 method 的連結都可以在類別或模組頁面左上方的字母順序目錄中找到。

執行個體 Method

頁面上：#dummy_instance_method 連結到 dummy_instance_method。
非頁面：RDoc::Alias#html_name 連結到 RDoc::Alias#html_name。

請參閱上方立即顯示的註解和專業提示。

屬性

頁面：#dummy_attribute 連結到 dummy_attribute。
非頁面：RDoc::Alias#name 連結到 RDoc::Alias#name。

別名

頁面：#dummy_instance_alias 連結到 dummy_instance_alias。
非頁面：RDoc::Alias#new_name 連結到 RDoc::Alias#new_name。

協定 http

連結：http://yahoo.com 連結到 yahoo.com。

協定 https

連結：https://github.com 連結到 github.com。

協定 www

連結：www.yahoo.com 連結到 www.yahoo.com.

協定 ftp

連結：ftp://nosuch.site 連結到 nosuch.site。

協定 mailto

連結：mailto:/[email protected] 連結到 [email protected]。

協定 irc

連結：irc://irc.freenode.net/ruby 連結到 irc.freenode.net/ruby。

影像檔名副檔名

連結：https://www.ruby-lang.org/images/[email protected] 轉換為內嵌式 HTML img 標籤，並在 HTML 中顯示影像

也適用於 bmp、gif、jpeg 和 jpg 檔案。

註解：僅適用於完全限定的 URL。

標題

連結：RDoc::RD@LICENSE 連結到 RDoc::RDoc::RD 中的 LICENSE。

請注意，實際標題中的空白會以可連結文字中的 + 字元表示。

連結：RDoc::Options@Saved+Options 連結到 RDoc::Options 中的 Saved Options。

標點符號和其他特殊字元必須像 CGI.escape 一樣進行跳脫。

專業提示：任何標題的連結都可以在頁面左上方的類別或模組字母順序目錄中取得。

區段

請參閱組織文件說明的指令。

連結：RDoc::Markup::ToHtml@Visitor 連結到 RDoc::Markup::ToHtml 中的 Visitor。

如果區段和標題共用同一個名稱，連結目標會是區段。

單字文字連結

使用方括號建立單字文字連結

GitHub[https://github.com] 連結至 GitHub。

多字文字連結

使用方括號和大括號建立多字文字連結。

{GitHub home page}[https://github.com] 連結至 GitHub home page。

rdoc-ref 架構

具有 rdoc-ref: 架構的連結會連結至參考的項目（如果該項目存在）。參考的項目可能是類別、模組、方法、檔案等。

類別：Alias[rdoc-ref:RDoc::Alias] 連結至 RDoc::Alias。
模組：RDoc[rdoc-ref:RDoc] 連結至 RDoc。
方法：foo[rdoc-ref:RDoc::Markup::ToHtml#handle_regexp_RDOCLINK] 連結至 foo。
常數：bar[rdoc-ref:RDoc::Markup::ToHtml::LIST_TYPE_TO_HTML] 連結至 bar。
屬性：baz[rdoc-ref:RDoc::Markup::ToHtml#code_object] 連結至 baz。
別名：bad[rdoc-ref:RDoc::MarkupReference#dummy_instance_alias] 連結至 bad。

如果參考的項目不存在，則不會產生連結，且整個 rdoc-ref: 方括號子句會從結果文字中移除。

Nosuch[rdoc-ref:RDoc::Nosuch] 會顯示為 Nosuch。

rdoc-label 架構

簡單

您可以使用此格式指定連結目標，其中第二個部分會引用 HTML 元素的 id。

此連結會連結至此頁面上的常數 DUMMY_CONSTANT

{DUMMY_CONSTANT}[rdoc-label:DUMMY_CONSTANT]

因此

DUMMY_CONSTANT

含回傳

您可以同時指定連結目標和區域標籤，該標籤可用作回傳連結的目標。這兩個連結會互相連結

{前往收件人}[rdoc-label:addressee:sender]
{返回寄件人}[rdoc-label:sender:addressee]

因此

前往收件人

一些文字。

返回寄件人

link: 架構

link:README_rdoc.html 連結至 README_rdoc.html。

rdoc-image 架構

使用 rdoc-image 架構顯示同時也是連結的圖片

# {rdoc-image:path/to/image}[link_target]

連結：{rdoc-image:https://www.ruby-lang.org/images/[email protected]}[https://www.ruby-lang.org] 將圖片 https://www.ruby-lang.org/images/[email protected] 顯示為連結至 https://www.ruby-lang.org。

目標的相對路徑也行得通

連結：{rdoc-image:https://www.ruby-lang.org/images/[email protected]}[./Alias.html] 連結至 ./Alias.html

跳脫文字¶ ↑

否則會被解釋為標記的文字可以「跳脫」，這樣它就不會被解釋為標記；跳脫字元是反斜線 ('\')。

在逐字文本區塊或程式碼區塊中，跳脫字元始終保留

範例輸入

This is not verbatim text.

  This is verbatim text, with an escape character \.

This is not a code block.

  def foo
    'String with an escape character.'
  end

呈現的 HTML

這不是逐字文字。

This is verbatim text, with an escape character \.

這不是程式碼區塊。

def foo
  'This is a code block with an escape character \.'
end

在字型標記（斜體、粗體或單字型）中，跳脫字元會保留，除非緊接在巢狀字型標記之後。

範例輸入

This list is about escapes; it contains:

- <tt>Monofont text with unescaped nested _italic_</tt>.
- <tt>Monofont text with escaped nested \_italic_</tt>.
- <tt>Monofont text with an escape character \</tt>.

呈現的 HTML

此清單是關於跳脫；它包含

未跳脫巢狀斜體的單字型文字.

已跳脫巢狀_斜體_的單字型文字.

帶有跳脫字元 \ 的單字型文字 .

在其他帶文字的區塊中（段落、區塊引號、清單項目、標題）

緊接在標記之後的單一跳脫字元會跳脫標記。
單一跳脫字元後接空白會保留。
單一跳脫字元在其他任何地方都會被忽略。
雙重跳脫字元會顯示為單一反斜線。

範例輸入
```
This list is about escapes; it contains:

- An unescaped class name, RDoc, that will become a link.
- An escaped class name, \RDoc, that will not become a link.
- An escape character followed by whitespace \ .
- An escape character \that is ignored.
- A double escape character \\ that is rendered
  as a single backslash.
```
呈現的 HTML
此清單是關於跳脫；它包含
- 未跳脫的類別名稱，RDoc，將會變成連結。
- 已跳脫的類別名稱，RDoc，不會變成連結。
- 跳脫字元後接空白 \ 。
- 被忽略的跳脫字元。
- 雙重跳脫字元 \ 會顯示為單一反斜線。

從 Ruby 程式碼衍生的文件¶ ↑

類別

預設情況下，RDoc 文件

類別名稱。
父類別。
單例方法。
實例方法。
別名。
常數。
屬性。

模組

預設情況下，RDoc 文件

模組名稱。
單例方法。
實例方法。
別名。
常數。
屬性。

方法

預設情況下，RDoc 文件

方法名稱。
參數。
讓步值。

請參閱 method。

別名

預設情況下，RDoc 文件

別名名稱。
別名名稱。

請參閱 dummy_instance_alias 和 dummy_instance_method。

常數

預設情況下，RDoc 文件

常數名稱。

請參閱 DUMMY_CONSTANT。

屬性

預設情況下，RDoc 文件

屬性名稱。
屬性類型（[R]、[W] 或 [RW]）

請參閱 dummy_attribute。

類別 RDoc::MarkupReference 僅存在於為 RDoc 標記提供適當的參考文件首頁。

在此類別中定義的所有物件（類別、模組、方法、別名、屬性和常數）僅用於說明 RDoc 標記，沒有其他合法用途。

RDoc 標記參考¶ ↑

注意事項

此參考中的範例為 Ruby 程式碼和註解；請注意與其他來源（例如 C 程式碼和註解）的某些差異。
顯示呈現的 HTML 輸出的範例會在區塊引號中顯示該輸出

呈現的 HTML

一些東西

RDoc 生成的文件是由下列項目衍生和控制的

某些定義之前的單行或多行註解；請參閱註解中的標記。
追蹤註解中的 RDoc 指令（與程式碼在同一行）；請參閱 :nodoc:、:doc: 和 :notnew:。
單行註解中的 RDoc 指令；請參閱其他指令。
Ruby 程式碼本身（但非 C 程式碼）；請參閱從 Ruby 程式碼衍生的文件。

註解中的標記¶ ↑

註解中標記的處理方式會根據檔案類型而有所不同

.rb（Ruby 程式碼檔案）：從 Ruby 註解中解析標記。
.c（C 程式碼檔案）：從 C 註解中解析標記。
.rdoc（RDoc 文字檔案）：從整個檔案中解析標記。

與 Ruby 類別、模組、方法、別名、常數或屬性相關聯的註解會成為該定義物件的文件。

在 Ruby 檔案中，該註解會緊接在物件定義之前。
在 C 檔案中，該註解會緊接在實作方法的函式之前，或緊接在物件定義之前。

在 Ruby 或 C 檔案中，RDoc 會忽略未出現在物件定義之前的註解。

在 RDoc 檔案中，文字不會與任何程式碼物件相關聯，但可能會（視文件建置方式而定）成為一個獨立的頁面。

此頁面上的幾乎所有範例都類似 RDoc；也就是說，它們沒有 Ruby # 或 C /* ... */ 等註解標記。

邊界¶ ↑

在多行註解中，RDoc 會尋找註解的自然左邊界，該邊界會成為註解的基本邊界，並且是註解的初始目前邊界。

目前邊界可以變更，例如在清單中。

區塊¶ ↑

將 RDoc 標記輸入視為一系列各種類型的區塊會很方便（詳細資訊請參閱連結）

段落：一般段落。
逐字文字區塊：要逐字呈現的文字區塊。
程式碼區塊：包含 Ruby 程式碼的逐字文字區塊，要以程式碼突顯方式呈現。
區塊引號：較長的引文段落，要以縮排方式呈現，而不是使用引號。
清單：項目清單、編號清單、字母清單或標籤清單的項目。
標題：章節標題。
水平規則：在呈現的頁面上的一條線。
指令：各種呈現的特殊指示。
文字標記：以特殊方式呈現的文字。

關於區塊

除了段落，區塊以其縮排或不尋常的開頭或嵌入字元區分。
任何區塊都可以獨立出現（即，未巢狀在另一個區塊中）；有些區塊可以巢狀，如下所述。

段落¶ ↑

段落包含一行或多行非空白的普通文字，每一行都從目前的邊界開始。

注意：這裡，普通文字是指未識別為縮排或不尋常的開頭或嵌入字元的文字。請參閱下方。

段落以一行或多行空白行分隔。

範例輸入

\RDoc produces HTML and command-line documentation for Ruby projects.
\RDoc includes the rdoc and ri tools for generating and displaying
documentation from the command-line.

You'll love it.

呈現的 HTML

RDoc 為 Ruby 專案產生 HTML 和命令列文件。RDoc 包含 rdoc 和 ri 工具，用於從命令列產生和顯示文件。

你會喜歡它的。

段落可能包含巢狀區塊，包括

逐字文字區塊¶ ↑

縮排比目前邊界更遠的文字會變成逐字文字區塊（或程式碼區塊，下述）。在呈現的 HTML 中，此類文字

已縮排。
具有對比的背景顏色。

逐字文字區塊在第一行從目前邊界開始時結束。

範例輸入

This is not verbatim text.

  This is verbatim text.
    Whitespace is honored.     # See?
      Whitespace is honored.     # See?

  This is still the same verbatim text block.

This is not verbatim text.

呈現的 HTML

這不是逐字文字。

This is verbatim text.
  Whitespace is honored.     # See?
    Whitespace is honored.     # See?

This is still the same verbatim text block.

這不是逐字文字。

逐字文字區塊可能不包含任何類型的巢狀區塊——它是逐字的。

程式碼區塊¶ ↑

逐字文字的一個特例是程式碼區塊，它僅是 RDoc 識別為 Ruby 程式碼的逐字文字

在呈現的 HTML 中，程式碼區塊

已縮排。
具有對比的背景顏色。
具有語法突顯。

範例輸入

Consider this method:

  def foo(name = '', value = 0)
    @name = name      # Whitespace is still honored.
    @value = value
  end

呈現的 HTML

考慮此方法

def foo(name = '', value = 0)
  @name = name      # Whitespace is still honored.
  @value = value
end

專業提示：如果縮排的 Ruby 程式碼沒有突顯，則它可能包含語法錯誤。

程式碼區塊可能不包含任何類型的巢狀區塊 – 它是逐字的。

區塊引號¶ ↑

您可以使用字元 >>>（未縮排），後接縮排文字，將文字視為區塊引號

範例輸入

Here's a block quote:
.
  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer
  commodo quam iaculis massa posuere, dictum fringilla justo pulvinar.
  Quisque turpis erat, pharetra eu dui at, sollicitudin accumsan nulla.

  Aenean congue ligula eu ligula molestie, eu pellentesque purus
  faucibus. In id leo non ligula condimentum lobortis. Duis vestibulum,
  diam in pellentesque aliquet, mi tellus placerat sapien, id euismod
  purus magna ut tortor.

呈現的 HTML

以下是區塊引號

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer commodo quam iaculis massa posuere, dictum fringilla justo pulvinar. Quisque turpis erat, pharetra eu dui at, sollicitudin accumsan nulla.

Aenean congue ligula eu ligula molestie, eu pellentesque purus faucibus. In id leo non ligula condimentum lobortis. Duis vestibulum, diam in pellentesque aliquet, mi tellus placerat sapien, id euismod purus magna ut tortor.

請注意，與逐字文字不同，單一換行不會被保留，但雙換行會在區塊引號中開始新段落。

區塊引號可能包含巢狀區塊，包括

清單¶ ↑

每種類型的清單項目都以特殊開頭標示

項目符號清單項目：以連字號或星號開頭。
編號清單項目：以數字和句點開頭。
字母清單項目：以字母和句點開頭。
標籤清單項目：以下列其中一項開頭
- 方括號文字。
- 一個字詞後接兩個冒號。

清單以清單項目開頭，並持續進行，即使跨越空白行，只要在相同縮排層級找到相同類型的清單項目。

新清單會將目前的邊界向內重置。在該邊界對齊的額外文字行是持續清單項目的一部分。

清單項目可以持續在與第一行對齊的額外行上。請參閱以下範例。

清單項目可能包含巢狀區塊，包括

項目符號清單¶ ↑

項目符號清單項目以連字號或星號開頭。

範例輸入

- An item.
- Another.
- An item spanning
  multiple lines.

* Yet another.
- Last one.

呈現的 HTML

一個項目。

另一個。

一個跨越多行的項目。

再一個。

最後一個。

編號清單¶ ↑

編號清單項目以數字和句號開頭。

項目會自動重新編號。

範例輸入

100. An item.
10. Another.
1. An item spanning
   multiple lines.

1. Yet another.
1000. Last one.

呈現的 HTML

一個項目。

另一個。

一個跨越多行的項目。

再一個。

最後一個。

字母清單¶ ↑

字母清單項目以字母和句號開頭。

項目會自動「重新編號」。

範例輸入

z. An item.
y. Another.
x. An item spanning
   multiple lines.

x. Yet another.
a. Last one.

呈現的 HTML

一個項目。

另一個。

再一個。

最後一個。

標籤清單¶ ↑

標籤清單項目以下列其中一項開頭

方括弧文字：標籤和文字分兩行。
字詞後接兩個冒號：標籤和文字在同一行。

範例輸入

[foo] An item.
bat:: Another.
[bag] An item spanning
      multiple lines.

[bar baz] Yet another.
bam:: Last one.

呈現的 HTML

foo

一個項目。

bat

另一個。

bag

一個跨越多行的項目。

bar baz

再一個。

bam

最後一個。

標題¶ ↑

標題以最多六個等號開頭，後接標題文字。這些等號和標題文字之間的空白可有可無。

範例

= Section 1
== Section 1.1
=== Section 1.1.1
=== Section 1.1.2
== Section 1.2
= Section 2
= Foo
== Bar
=== Baz
==== Bam
===== Bat
====== Bad
============Still a Heading (Level 6)
\== Not a Heading

標題只能包含一種巢狀區塊

文字標記.

水平規則¶ ↑

水平規則由一行組成，該行包含三個或更多連字號，且沒有其他內容。

範例輸入

---
--- Not a horizontal rule.

-- Also not a horizontal rule.
---

呈現的 HTML

— 不是水平規則。

– 也不是水平規則。

指令¶ ↑

允許或禁止文件指令¶ ↑

# :stopdoc:
- 出現在單獨一行上。
- 指定 RDoc 應略過標記，直到下一個 :startdoc: 指令或檔案結尾。
# :startdoc:
- 出現在單獨一行上。
- 指定 RDoc 應繼續分析標記。
# :enddoc:
- 出現在單獨一行上。
- 指定 RDoc 應略過標記至檔案結尾，不論其他指令為何。
# :nodoc:
- 附加至定義類別、模組、方法、別名、常數或屬性的程式碼行。
- 指定不應記錄已定義的物件。
- 對於 C 程式碼中的方法定義，必須置於實作之前
```
/* :nodoc: */
static VALUE
some_method(VALUE self)
{
    return self;
}
```
  請注意，此指令在方法定義位置完全無效。例如，
```
/* :nodoc: */
rb_define_method(cMyClass, "do_something", something_func, 0);
```
  上述註解只是一個註解，與 RDoc 無關。因此，do_something 方法將報告為「未記錄」，除非該方法或函式在其他地方有記錄。
- 在 C 程式碼中的常數定義中，這個指令無法運作，因為沒有常數的「實作」位置。
# :nodoc: all:
- 附加在定義類別或模組的程式碼行中。
- 指定類別或模組不應記錄。然而，預設情況下，巢狀類別或模組會記錄。
# :doc:
- 附加至定義類別、模組、方法、別名、常數或屬性的程式碼行。
- 指定已定義的物件應記錄，即使在其他情況下不應記錄。
# :notnew:（別名為 :not_new: 和 :not-new:）
- 附加在定義實例方法 initialize 的程式碼行中。
- 指定單例方法 new 不應記錄。預設情況下，Ruby 模擬對應的單例方法 new，RDoc 會將其包含在記錄中。請注意，實例方法 initialize 是私有的，因此預設情況下不會記錄。

對於 Ruby 程式碼，但對於其他 RDoc 來源則不然，:stopdoc: 和 :startdoc: 有簡寫。

# Documented.
#--
# Not documented.
#++
# Documented.

對於 C 程式碼，任何指令 :startdoc:、:stopdoc: 和 :enddoc: 都可能出現在獨立註解中

/* :startdoc: */
/* :stopdoc: */
/* :enddoc: */

指定 RDoc 來源格式的指令¶ ↑

# :markup: type:
- 出現在單獨一行上。
- 指定 RDoc 輸入的格式；參數 type 是 markdown、rd、rdoc、tomdoc 之一。

HTML 輸出的指令¶ ↑

# :title: text:
- 出現在單獨一行上。
- 指定 HTML 輸出的標題。
# :main: filename:
- 出現在單獨一行上。
- 指定要首先顯示的 HTML 檔案。

`Method` 記錄的指令¶ ↑

# :call-seq:
- 出現在單獨一行上。
- 指定要在 HTML 中報告的呼叫順序，覆寫程式碼中的實際呼叫順序。請參閱方法 call_seq_directive。
請注意，RDoc 可以為 Ruby 編碼的方法建立呼叫順序，但無法為其他語言建立。如果您想包含，您可能需要透過明確提供 :call-seq: 指令來覆寫它
- 回傳類型，不會自動推論。
- 多個呼叫順序。
對於 C 程式碼，指令可能出現在獨立註解中。
# :args: arg_names（別名為 :arg:）
- 出現在單獨一行上。
- 指定要回報在 HTML 中的參數，覆寫程式碼中的實際參數。請參閱方法 args_directive。
# :yields: arg_names（別名為 :yield:）
- 出現在單獨一行上。
- 指定要回報在 HTML 中的 yield 參數，覆寫程式碼中的實際 yield。請參閱方法 yields_directive。

組織文件說明的指令¶ ↑

預設情況下，RDoc 會將

單例方法依字母順序分組。
實例方法及其別名依字母順序分組。
屬性和其別名依字母順序分組。

您可以使用指令來修改這些行為。

# :section: section_title:
- 出現在單獨一行上。
- 指定後續方法應分組到具有給定 section_title 的區段，或在未給定標題的情況下分組到預設區段。此指令會持續有效，直到給出另一個此類指令，但可能會被指令 :category: 暫時覆寫。請參閱下方。
包含此指令的註解區塊
- 必須與下一項的文件說明以空白行分隔。
- 可以在指令前面有一行或多行。這些行將會移除，以及任何與它們相符的尾行。這些行在視覺上可能會有幫助。
- 未被移除的文字行會成為區段的描述文字。
範例
```
# ----------------------------------------
# :section: My Section
# This is the section that I wrote.
# See it glisten in the noon-day sun.
# ----------------------------------------

##
# Comment for some_method
def some_method
  # ...
end
```
您可以使用指令 :category: 來暫時覆寫目前的區段。
# :category: section_title:
- 出現在單獨一行上。
- 指定只有一個後續方法要包含在給定的區段中，或在未給定標題的情況下包含在預設區段中。後續方法應分組到目前的區段。

包含 `File` 的指令¶ ↑

# :include: filepath:
- 出現在單獨一行上。
- 指定給定檔案的內容應包含在這個點。檔案內容會被移位，與指令開頭的冒號具有相同的縮排。
  
  檔案會在使用 --include 命令列選項給出的目錄中搜尋，或預設在目前目錄中搜尋。
對於 C 程式碼，指令可能會出現在獨立的註解中

文字標記¶ ↑

文字標記是會影響 HTML 呈現的元文字

字型：斜體、粗體、單字型。
字元轉換：版權、商標、特定標點符號。
連結。
跳脫：將文字標記為「非標記」。

字體標記¶ ↑

字體標記可以指定文字以斜體、粗體或等寬字體呈現。

字體標記只能包含一種巢狀區塊

更多字體標記：斜體、粗體、等寬字體。

斜體¶ ↑

文字可以透過 HTML 標籤  或  標示為斜體。

範例輸入

<i>Italicized words</i> in a paragraph.

.
  <i>Italicized words in a block quote</i>.

- <i>Italicized words</i> in a list item.

====== <i>Italicized words</i> in a Heading

<i>Italicized passage containing *bold* and +monofont+.</i>

呈現的 HTML

斜體字 出現在段落中。

斜體字出現在區塊引用中.

斜體字 出現在清單項目中。

斜體字 出現在標題中¶ ↑

包含粗體和 等寬字體 的斜體段落。

單一字詞可以透過簡寫標示為斜體：加上前後底線。

範例輸入

_Italic_ in a paragraph.

.
  _Italic_ in a block quote.

- _Italic_ in a list item.

====== _Italic_ in a Heading

呈現的 HTML

斜體出現在段落中。

斜體出現在區塊引用中。

斜體出現在清單項目中。

斜體出現在標題中¶ ↑

粗體¶ ↑

文字可以透過 HTML 標籤  標示為粗體。

範例輸入

<b>Bold words</b> in a paragraph.

.
  <b>Bold words</b> in a block quote.

- <b>Bold words</b> in a list item.

====== <b>Bold words</b> in a Heading

<b>Bold passage containing _italics_ and +monofont+.</b>

呈現的 HTML

粗體字 出現在段落中。

粗體字 出現在區塊引用中。

粗體字 出現在清單項目中。

粗體字 出現在標題中¶ ↑

包含斜體和 等寬字體 的粗體段落。

單一字詞可以透過簡寫標示為粗體：加上前後星號。

範例輸入

*Bold* in a paragraph.

.
  *Bold* in a block quote.

- *Bold* in a list item.

===== *Bold* in a Heading

呈現的 HTML

粗體出現在段落中。

粗體出現在區塊引用中。

粗體出現在清單項目中。

粗體出現在標題中¶ ↑

等寬字體¶ ↑

文字可以透過 HTML 標籤 <tt> 或 <code> 標示為等寬字體（有時稱為「打字機字體」）。

範例輸入

<tt>Monofont words</tt> in a paragraph.

.
  <tt>Monofont words</tt> in a block quote.

- <tt>Monofont words</tt> in a list item.

====== <tt>Monofont words</tt> in heading

<tt>Monofont passage containing _italics_ and *bold*.</tt>

呈現的 HTML

等寬字體字詞 出現在段落中。

等寬字體字詞 出現在區塊引用中。

等寬字體字詞 出現在清單項目中。

等寬字體字詞 出現在標題中¶ ↑

包含斜體和粗體的等寬字體段落。

單一字詞可以透過簡寫標示為等寬字體：加上前後加號。

範例輸入

+Monofont+ in a paragraph.

.
  +Monofont+ in a block quote.

- +Monofont+ in a list item.

====== +Monofont+ in a Heading

呈現的 HTML

等寬字體 出現在段落中。

等寬字體 出現在區塊引用中。

清單項目中的單字型。

標題中的單字型¶ ↑

字元轉換¶ ↑

某些字元組合可能會轉換為特殊字元；是否轉換取決於目前編碼中是否有該特殊字元。

(r) 轉換為 ®（註冊商標字元）；必須是小寫。
'foo' 轉換為 ‘foo’（智慧型單引號）。
"foo" 轉換為 “foo”（智慧型雙引號）。
foo ... bar 轉換為 foo … bar（1 個字元省略號）。
foo -- bar 轉換為 foo – bar（1 個字元連字號）。
foo --- bar 轉換為 foo — bar（1 個字元破折號）。

連結¶ ↑

RDoc 文字中的某些字串會轉換為連結。可以在任何此類連結前加上反斜線來抑制連結。本節說明如何連結到各種目標。

類別

頁面上：DummyClass 連結到 DummyClass。
頁面外：RDoc::Alias 連結到 RDoc::Alias。

模組

頁面上：DummyModule 連結到 DummyModule。
頁面外：RDoc 連結到 RDoc。

常數

頁面上：DUMMY_CONSTANT 連結到 DUMMY_CONSTANT。
頁面外：RDoc::Text::MARKUP_FORMAT 連結到 RDoc::Text::MARKUP_FORMAT。

單例 Method

頁面上：::dummy_singleton_method 連結到 ::dummy_singleton_method。
頁面外RDoc::TokenStream::to_html 連結到 RDoc::TokenStream::to_html。

注意：有時 RDoc 沒有連結到名稱僅包含特殊字元的 method。請檢查您預期的連結是否實際存在。如果沒有，您需要建立明確的連結；請參閱下方。

專業提示：任何 method 的連結都可以在類別或模組頁面左上方的字母順序目錄中找到。

執行個體 Method

頁面上：#dummy_instance_method 連結到 dummy_instance_method。
非頁面：RDoc::Alias#html_name 連結到 RDoc::Alias#html_name。

請參閱上方立即顯示的註解和專業提示。

屬性

頁面：#dummy_attribute 連結到 dummy_attribute。
非頁面：RDoc::Alias#name 連結到 RDoc::Alias#name。

別名

頁面：#dummy_instance_alias 連結到 dummy_instance_alias。
非頁面：RDoc::Alias#new_name 連結到 RDoc::Alias#new_name。

協定 http

連結：http://yahoo.com 連結到 yahoo.com。

協定 https

連結：https://github.com 連結到 github.com。

協定 www

連結：www.yahoo.com 連結到 www.yahoo.com.

協定 ftp

連結：ftp://nosuch.site 連結到 nosuch.site。

協定 mailto

連結：mailto:/[email protected] 連結到 [email protected]。

協定 irc

連結：irc://irc.freenode.net/ruby 連結到 irc.freenode.net/ruby。

影像檔名副檔名

連結：https://www.ruby-lang.org/images/[email protected] 轉換為內嵌式 HTML img 標籤，並在 HTML 中顯示影像

也適用於 bmp、gif、jpeg 和 jpg 檔案。

註解：僅適用於完全限定的 URL。

標題

連結：RDoc::RD@LICENSE 連結到 RDoc::RDoc::RD 中的 LICENSE。

請注意，實際標題中的空白會以可連結文字中的 + 字元表示。

連結：RDoc::Options@Saved+Options 連結到 RDoc::Options 中的 Saved Options。

標點符號和其他特殊字元必須像 CGI.escape 一樣進行跳脫。

專業提示：任何標題的連結都可以在頁面左上方的類別或模組字母順序目錄中取得。

區段

請參閱組織文件說明的指令。

連結：RDoc::Markup::ToHtml@Visitor 連結到 RDoc::Markup::ToHtml 中的 Visitor。

如果區段和標題共用同一個名稱，連結目標會是區段。

單字文字連結

使用方括號建立單字文字連結

GitHub[https://github.com] 連結至 GitHub。

多字文字連結

使用方括號和大括號建立多字文字連結。

{GitHub home page}[https://github.com] 連結至 GitHub home page。

rdoc-ref 架構

具有 rdoc-ref: 架構的連結會連結至參考的項目（如果該項目存在）。參考的項目可能是類別、模組、方法、檔案等。

類別：Alias[rdoc-ref:RDoc::Alias] 連結至 RDoc::Alias。
模組：RDoc[rdoc-ref:RDoc] 連結至 RDoc。
方法：foo[rdoc-ref:RDoc::Markup::ToHtml#handle_regexp_RDOCLINK] 連結至 foo。
常數：bar[rdoc-ref:RDoc::Markup::ToHtml::LIST_TYPE_TO_HTML] 連結至 bar。
屬性：baz[rdoc-ref:RDoc::Markup::ToHtml#code_object] 連結至 baz。
別名：bad[rdoc-ref:RDoc::MarkupReference#dummy_instance_alias] 連結至 bad。

如果參考的項目不存在，則不會產生連結，且整個 rdoc-ref: 方括號子句會從結果文字中移除。

Nosuch[rdoc-ref:RDoc::Nosuch] 會顯示為 Nosuch。

rdoc-label 架構

簡單

您可以使用此格式指定連結目標，其中第二個部分會引用 HTML 元素的 id。

此連結會連結至此頁面上的常數 DUMMY_CONSTANT

{DUMMY_CONSTANT}[rdoc-label:DUMMY_CONSTANT]

因此

DUMMY_CONSTANT

含回傳

您可以同時指定連結目標和區域標籤，該標籤可用作回傳連結的目標。這兩個連結會互相連結

{前往收件人}[rdoc-label:addressee:sender]
{返回寄件人}[rdoc-label:sender:addressee]

因此

前往收件人

一些文字。

返回寄件人

link: 架構

link:README_rdoc.html 連結至 README_rdoc.html。

rdoc-image 架構

使用 rdoc-image 架構顯示同時也是連結的圖片

# {rdoc-image:path/to/image}[link_target]

連結：{rdoc-image:https://www.ruby-lang.org/images/[email protected]}[https://www.ruby-lang.org] 將圖片 https://www.ruby-lang.org/images/[email protected] 顯示為連結至 https://www.ruby-lang.org。

目標的相對路徑也行得通

連結：{rdoc-image:https://www.ruby-lang.org/images/[email protected]}[./Alias.html] 連結至 ./Alias.html

跳脫文字¶ ↑

否則會被解釋為標記的文字可以「跳脫」，這樣它就不會被解釋為標記；跳脫字元是反斜線 ('\')。

在逐字文本區塊或程式碼區塊中，跳脫字元始終保留

範例輸入

This is not verbatim text.

  This is verbatim text, with an escape character \.

This is not a code block.

  def foo
    'String with an escape character.'
  end

呈現的 HTML

這不是逐字文字。

This is verbatim text, with an escape character \.

這不是程式碼區塊。

def foo
  'This is a code block with an escape character \.'
end

在字型標記（斜體、粗體或單字型）中，跳脫字元會保留，除非緊接在巢狀字型標記之後。

範例輸入

This list is about escapes; it contains:

- <tt>Monofont text with unescaped nested _italic_</tt>.
- <tt>Monofont text with escaped nested \_italic_</tt>.
- <tt>Monofont text with an escape character \</tt>.

呈現的 HTML

此清單是關於跳脫；它包含

未跳脫巢狀斜體的單字型文字.

已跳脫巢狀_斜體_的單字型文字.

帶有跳脫字元 \ 的單字型文字 .

在其他帶文字的區塊中（段落、區塊引號、清單項目、標題）

緊接在標記之後的單一跳脫字元會跳脫標記。
單一跳脫字元後接空白會保留。
單一跳脫字元在其他任何地方都會被忽略。
雙重跳脫字元會顯示為單一反斜線。

範例輸入
```
This list is about escapes; it contains:

- An unescaped class name, RDoc, that will become a link.
- An escaped class name, \RDoc, that will not become a link.
- An escape character followed by whitespace \ .
- An escape character \that is ignored.
- A double escape character \\ that is rendered
  as a single backslash.
```
呈現的 HTML
此清單是關於跳脫；它包含
- 未跳脫的類別名稱，RDoc，將會變成連結。
- 已跳脫的類別名稱，RDoc，不會變成連結。
- 跳脫字元後接空白 \ 。
- 被忽略的跳脫字元。
- 雙重跳脫字元 \ 會顯示為單一反斜線。

從 Ruby 程式碼衍生的文件¶ ↑

類別

預設情況下，RDoc 文件

類別名稱。
父類別。
單例方法。
實例方法。
別名。
常數。
屬性。

模組

預設情況下，RDoc 文件

模組名稱。
單例方法。
實例方法。
別名。
常數。
屬性。

方法

預設情況下，RDoc 文件

方法名稱。
參數。
讓步值。

請參閱 method。

別名

預設情況下，RDoc 文件

別名名稱。
別名名稱。

請參閱 dummy_instance_alias 和 dummy_instance_method。

常數

預設情況下，RDoc 文件

常數名稱。

請參閱 DUMMY_CONSTANT。

屬性

預設情況下，RDoc 文件

屬性名稱。
屬性類型（[R]、[W] 或 [RW]）

請參閱 dummy_attribute。

常數

DUMMY_CONSTANT: 範例常數

屬性

dummy_attribute[RW]

範例屬性

dummy_attribute_alias[RW]

範例屬性

公開類別方法

dummy_singleton_method(foo, bar) 按一下以切換來源

範例單例方法

# File rdoc/markup_reference.rb, line 1226
def self.dummy_singleton_method(foo, bar); end

公開實例方法

args_directive(baz) 按一下以切換來源

:args: 指令會覆寫 Ruby 程式碼中找到的實際參數。

按一下呼叫順序以查看程式碼。

# File rdoc/markup_reference.rb, line 1274
def args_directive(foo, bar) # :args: baz
  nil
end

call_seq_directive(foo, bar) 按一下以切換來源

可以是任何東西 → bar

也可以是更多任何東西 → baz 或 bat

:call-seq: 指令會覆寫 Ruby 程式碼中找到的實際呼叫順序。

它可以指定任何東西。
它可以有多個呼叫順序。

這個包含 可以是任何東西 -> foo，這是無稽之談。

請注意，「箭頭」是兩個字元，連字號和右角度括號，在 HTML 中會變成一個字元。

按一下呼叫順序以查看程式碼。

以下是為方法提供的 :call-seq: 指令

:call-seq:
  call_seq_directive(foo, bar)
  Can be anything -> bar
  Also anything more -> baz or bat

# File rdoc/markup_reference.rb, line 1266
def call_seq_directive
  nil
end

dummy_instance_alias(foo, bar)

別名為：dummy_instance_method

dummy_instance_method(foo, bar) 按一下以切換來源

範例實例方法

# File rdoc/markup_reference.rb, line 1229
def dummy_instance_method(foo, bar); end

也別名為：dummy_instance_alias、dummy_instance_alias

method(foo, bar) { |'baz'| ... } 按一下以切換來源

這個方法僅由 RDoc 記錄，這些註解除外。

按一下呼叫順序以查看程式碼。

# File rdoc/markup_reference.rb, line 1290
def method(foo, bar)
  yield 'baz'
end

yields_directive(foo, bar) { |'bat'| ... } 按一下以切換來源

:yields: 指令會覆寫 Ruby 程式碼中找到的實際讓步。

按一下呼叫順序以查看程式碼。

# File rdoc/markup_reference.rb, line 1282
def yields_directive(foo, bar) # :yields: 'bat'
  yield 'baz'
end

類別 RDoc::MarkupReference

RDoc 標記參考¶ ↑

註解中的標記¶ ↑

邊界¶ ↑

區塊¶ ↑

段落¶ ↑

逐字文字區塊¶ ↑

程式碼區塊¶ ↑

區塊引號¶ ↑

清單¶ ↑

項目符號清單¶ ↑

編號清單¶ ↑

字母清單¶ ↑

標籤清單¶ ↑

標題¶ ↑

水平規則¶ ↑

指令¶ ↑

允許或禁止文件指令¶ ↑

指定 RDoc 來源格式的指令¶ ↑

HTML 輸出的指令¶ ↑

Method 記錄的指令¶ ↑

組織文件說明的指令¶ ↑

包含 File 的指令¶ ↑

文字標記¶ ↑

字體標記¶ ↑

斜體¶ ↑

斜體字 出現在標題中¶ ↑

斜體 出現在標題中¶ ↑

粗體¶ ↑

粗體字 出現在標題中¶ ↑

粗體 出現在標題中¶ ↑

等寬字體¶ ↑

等寬字體字詞 出現在標題中¶ ↑

標題中的單字型¶ ↑

字元轉換¶ ↑

連結¶ ↑

跳脫文字¶ ↑

從 Ruby 程式碼衍生的文件¶ ↑

RDoc 標記參考¶ ↑

註解中的標記¶ ↑

邊界¶ ↑

區塊¶ ↑

段落¶ ↑

逐字文字區塊¶ ↑

程式碼區塊¶ ↑

區塊引號¶ ↑

清單¶ ↑

項目符號清單¶ ↑

編號清單¶ ↑

字母清單¶ ↑

標籤清單¶ ↑

標題¶ ↑

水平規則¶ ↑

指令¶ ↑

允許或禁止文件指令¶ ↑

指定 RDoc 來源格式的指令¶ ↑

HTML 輸出的指令¶ ↑

Method 記錄的指令¶ ↑

組織文件說明的指令¶ ↑

包含 File 的指令¶ ↑

文字標記¶ ↑

字體標記¶ ↑

斜體¶ ↑

斜體字 出現在標題中¶ ↑

斜體 出現在標題中¶ ↑

粗體¶ ↑

粗體字 出現在標題中¶ ↑

粗體 出現在標題中¶ ↑

等寬字體¶ ↑

等寬字體字詞 出現在標題中¶ ↑

標題中的單字型¶ ↑

字元轉換¶ ↑

連結¶ ↑

跳脫文字¶ ↑

從 Ruby 程式碼衍生的文件¶ ↑

`Method` 記錄的指令¶ ↑

包含 `File` 的指令¶ ↑

斜體字出現在標題中¶ ↑

斜體出現在標題中¶ ↑

粗體字出現在標題中¶ ↑

粗體出現在標題中¶ ↑

`等寬字體字詞` 出現在標題中¶ ↑

標題中的`單字型`¶ ↑

`Method` 記錄的指令¶ ↑

包含 `File` 的指令¶ ↑

斜體字出現在標題中¶ ↑

斜體出現在標題中¶ ↑

粗體字出現在標題中¶ ↑

粗體出現在標題中¶ ↑

`等寬字體字詞` 出現在標題中¶ ↑

標題中的`單字型`¶ ↑