空白符号

空白符号包括空格、空行等,其中空格分为半角空格和全角空格。

空白的使用

技术文档中使用空白符号建议遵循以下规范。

空白类型 相应规范
空格 - 禁止使用全角空格,一律使用半角空格
- 中文字符(包括汉字和中文标点符号)和中文字符之间禁止空半角空格。
- 英文字符和阿拉伯数字一般使用半角格式,所以应使用半角空格包围,以下情况例外:1)位于句首时,左边空格省略; 2)其右侧为半角标点或全角标点时,右边空格省略。
- 除表示缩进、列表级别、代码块中固有空格、Markdown 表格中的空格外,禁止连续出现两个及以上的半角空格。
- 不建议使用 Tab(制表符)替换空格。
空行 - 不同段落间建议使用一个空行隔开。
- 不同排版格式之间建议使用一个空行隔开,如标题与紧跟着的正文之间,正文与代码块之间、正文与表格之间等。
- 禁止连续出现两个及以上的空行。
其他 行宽:相同排版格式内保持一致即可,可自由在 80、120 字符中选择,原则上不超过 160 字符宽。

Tab 和空格的使用

技术文档中经常使用 Tab 键和空格键进行缩进和对齐。由于在不同的编辑器里 Tab 的默认长度可能不一致,用 Tab 键设置缩进可能导致格式混乱。如果使用空格键设置缩进,则用任何编辑器打开文档都会显示一样的对齐效果。

因此建议:

  • 使用空格键而不用 Tab 键进行缩进或对齐。

  • 使用 Tab 键缩进是可以接受的,但禁止混用 Tab 和空格进行缩进。

  • 在 Visual Studio Code 等编辑器里统一设置一个 Tab 等于四个半角空格。