文档惯例
以下是 Amazon 技术出版物的常见印刷惯例。
- 内联代码 (例如命令、操作、参数、常数、XML 元素和正则表达式)
-
格式:文本采用等宽字体
示例:
java -version
- 示例数据块 (例如,示例代码和脚本)
-
格式:阴影块中的文本,采用等宽字体
例如:
# ls -l /var/www/html/index.html -rw-rw-r-- 1 root root 1872 Jun 21 09:33 /var/www/html/index.html # date Wed Jun 21 09:33:42 EDT 2006
- 互斥选项
-
格式:用竖线分隔的文本
示例:
(start | stride | edge)
- 可选参数
-
格式:文本用方括号括起
示例:
[-n, -quiet]
- 定义
-
格式:斜体文本
示例:Amazon Machine Image(AMI)
- 技术出版物
-
格式:斜体文本
示例:《Amazon Simple Storage Service 用户指南》
- 用户界面中的元素
-
格式:粗体文本
示例:选择文件、属性。
- 用户输入 (用户键入的文本)
-
格式:文本采用等宽字体
示例:对于名称,键入
my-new-resource
。 - 必需值的占位符文本
-
格式:
斜体
文本例如:
aws ec2 register-image --image-location
my-s3-bucket
/image.manifest.xml