通用指南

行长度

将源代码行换行，使行长度不超过 79 个字符。此要求符合 PEP8 标准（来自 Python），并有助于在审查时进行并排差异比较。

注意

此规则的例外情况是代码块元素和引用中的链接内容。

在格式化假定长文本行的表格时，优先使用以下方法之一，而不是 table 指令

• 使用 list-table 指令格式化表格。

• 使用 csv-table 指令格式化表格。

• 尽可能使用定义列表格式化信息，以避免使用表格。

空格和制表符

• 在代码中不要使用制表符，而应使用空格。

• 不要在行尾添加空格。如果使用，linting 测试将因尾随空格而失败。

缩进

非常小心地使用缩进并保持一致，因为它对内容嵌套很重要。任何与前一个缩进长度不同的缩进，都会结束当前内容级别，要么引入新的内容子级别，要么移至上层内容级别。

使用缩进格式化以下嵌套内容：

• 定义列表

• 提示信息（注释、警告等）

• 代码块

• 列表和 CSV 表格

有关如何格式化上述列表中的元素，请参阅本章的相关部分。