文档约定
CA ControlMinder 文档使用以下约定:
格式 |
含义 |
---|---|
等宽字体 |
代码或程序输出 |
斜体 |
重点或新术语 |
粗体 |
必须完全按照显示内容键入的文本 |
正斜杠 (/) |
用于描述 UNIX 和 Windows 路径的独立于平台的目录分隔符 |
文档在解释命令语法和用户输入(以等宽字体显示)时还会使用以下特殊约定:
格式 |
含义 |
---|---|
斜体 |
您必须提供的信息 |
用方括号括起来 ([]) |
可选运算符 |
用大括号括起来 ({}) |
强制运算符集 |
用管道符 (|) 分隔的选项。 |
分隔可选运算符(选择一项)。 例如:下面的示例既可以表示用户名,也可以表示组名: {username|groupname} |
... |
指明前面的项或项组可以重复 |
下划线 |
默认值 |
前面带空格的行尾反斜杠 ( \) |
有时,在本指南中,一行无法容纳一个命令。 在这些情况下,行结尾处的空格加上反斜杠 ( \) 就表示该命令延续到下一行。 注意:请勿复制反斜杠字符,并且请省略换行符。 这些不是实际命令语法的一部分。 |
示例:命令表示法约定
下面的代码说明了在本指南中使用命令约定的方式:
ruler className [props({all|{propertyName1[,propertyName2]...})]
在该示例中:
版权所有 © 2013 CA。
保留所有权利。
|
|