程式碼和文字元素的樣式慣例

上次更新: 2023-05-21
  • 主題:
  • Reference
    檢視有關此主題的更多資訊

這些元素標識了幫助文檔中使用的代碼選項和變數。 通常,您不會在代碼或資料檔案中包含這些符號或樣式元素。 它們只是視覺指示器。

《公約》 解釋

variable

變數顯示在 斜體。 替換變數名稱的相應值。

為了視覺清晰,有時變數和其他代碼元素會出現在< >括弧之間。 您不需要在代碼中使用這些符號。

[optional]

方括弧中的項是可選項。

(this|that)

括弧中的項表示布爾值 選項。

literal

如所示完全包括文本或代碼。

< >

有時,變數和其他代碼元素會出現在< >括弧之間。 這些用於提高長代碼塊中的清晰度。 除非指定,否則不要在資料檔案名或其內容中包含這些符號。

本頁內容