Office 开发人员文档的的文档约定
我们的文档使用特定的文档约定可帮助您将源代码与语言元素、 键盘序列等区分开来。下表说明整个 Office 开发人员文档,使用的约定,并按产品出异常调用。
**上次修改时间:**2015年9月17日
**适用范围:**Office 2010 | Office 2013
应用所有的 Office 开发人员产品和技术中的印刷约定
约定 |
说明 |
示例 |
---|---|---|
等宽字体 |
指示源代码、 代码示例、 命令行、 应用程序输出、 代码行输入嵌入文本和变量以及代码元素中。 |
Public Class |
粗体 |
指示大多数预定义编程元素,包括命名空间、 类、 委托、 对象、 接口、 方法、 函数、 宏、 结构、 构造函数、 属性、 事件、 枚举、 字段、 运算符、 语句、 指令、 数据类型、 关键字、 异常、 非 HTML 属性和配置标记,以及注册表项、 子项和值。此外指出下列 HTML 元素: 属性 (大小写)、 指令、 关键字、 值和标头。另外,指示,必须严格按照所示输入必需的用户输入 (包括命令行选项)。最后,指示 XML 元素名称和 XML 属性名称 (这类型化的 XSD 中编写)。 |
Path类 解决方法 href属性 元素的代码段 关键字属性 |
倾斜 |
指示占位符、 最常用的方法或函数参数和 HTML 占位符;这些占位符表示必须由实现或由用户提供的信息。对于命令行输入,指示参数值。 |
上下文参数 |
大写字母 |
指示键和键序列的名称。此外指示 HTML 元素名称。 |
Enter Ctrl+R HTML 元素 |
加号 |
指示键组合。例如,ALT + F1 是指在按下 F1 键时按住 ALT 键。 |
ALT + F1 |
按产品的文档约定的例外情况
Product |
约定 |
说明 |
示例 |
---|---|---|---|
Visio |
纯文本 camel 大小写 |
指示单元格和行。 |
AlignMiddle 单元格 ArcTo 行 |
Visio |
纯文本大写字母 |
指示函数 |
ANGLETOLOC Function |
Visio |
纯文本、 标题大写 |
表明部分 |
Shape Layout Section |