代码和文本元素的样式约定 style-conventions-for-code-and-text-elements

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

约定
说明
variable

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

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

[optional]
方括号中的项目是可选的。
(this|that)
括号中的项表示布尔值或选择。
literal
完全包括显示的文本或代码。
< >
有时,变量和其他代码元素会显示在< >括号之间。 它们用于提高长代码块中的清晰度。 除非另外指定,否则不要在数据文件名或其内容中包含这些符号。
recommendation-more-help
de293fbf-b489-49b0-8daa-51ed303af695