代码和文本元素的样式约定

这些元素可识别在帮助文档中使用的代码选项和变量。 通常,您不会在代码或数据文件中包含这些符号或样式元素。 它们只是视觉指示器。

约定 说明

variable

变量以斜体显示。 将相应的值替换为变量名称。

为了视觉清晰起见,有时变量和其他代码元素会显示在< >括号之间。 您无需在代码中使用这些符号。

[optional]

方括号中的项目是可选的。

(this|that)

括号中的项目表示布尔值选项。

literal

完全按所示包含文本或代码。

< >

有时,变量和其他代码元素会显示在< >括号之间。 它们用于提高长代码块的清晰度。 除非另外指定,否则请勿在数据文件名或其内容中包含这些符号。

在此页面上