列表¶
当用户第一次阅读文档时,他们会快速浏览页面,只停留在突出显示的内容上,例如标题、列表、链接、图表等。列表有助于组织选项,并帮助读者轻松找到信息。
列出项目时,请遵循以下准则
对于选项,使用项目符号列表。当需要描述三个以上的选项时,创建项目符号列表。
对于步骤,使用编号列表。
使用定义列表来解释术语或描述命令行参数、选项或参数。
在介绍列表的句子末尾使用冒号。
对列表中的所有项目使用相同的语法结构(即平行结构)。
每个选项以大写字母开头。
在段落中列出选项时,在列表中的最后一个项目前添加和或或。如果这些连词连接三个或更多项目,则在它们前面使用序列(牛津)逗号。
列表中的标点符号¶
在项目符号列表中
如果您列出单个单词或短语,请不要在每个列表项的末尾添加句点。
如果您使用完整的句子,请在每个句子的末尾添加句点。
如果您的列表既包含单个单词或短语,又包含完整的句子,请保持一致,要么为所有项目添加句点,要么不添加句点。
在编号列表中
在步骤的末尾添加句点。
如果编号列表中的某个项目后面跟着一个说明如何执行该步骤的代码块,请在末尾使用冒号。