4.3 表格
表格必须有表头
所有表格必须包含表头行,且表头应清晰描述每列内容。如表格较复杂,应添加表格标题(caption)。
参数说明:
| 参数名 | 类型 | 说明 |
| timeout | int | 超时时间(秒) |
| retries | int | 重试次数 |
timeout:int 类型,超时时间(秒)
retries:int 类型,重试次数
使用表格可以让多维度信息更加清晰,读者能快速定位所需内容。纯文本罗列在参数较多时不利于阅读。
表格列数不宜超过六列
单个表格的列数建议不超过 6 列。列数过多会导致表格在小屏幕上难以阅读,也增加理解难度。如需展示更多维度的信息,应考虑拆分为多个表格或改用其他展示形式。
如果表格确实需要较多列,可考虑:将次要信息移至脚注;将相关列合并为一列;或将表格拆分为多个小表格。
表格内容对齐方式保持一致
同一列中的数据应使用统一的对齐方式。一般而言,文字内容左对齐,数值内容右对齐,表头居中对齐。整个表格的对齐风格应保持一致。
同一列的数据格式必须统一
同一列中的数据应使用统一的格式。例如,日期列统一使用 YYYY-MM-DD 格式,金额列统一保留两位小数,百分比列统一使用 % 符号。不得在同一列中混用不同格式。
| 版本 | 发布日期 | 下载量 |
| v2.1.0 | 2025-03-15 | 12,580 |
| v2.0.0 | 2024-11-20 | 45,320 |
| v1.9.5 | 2024-08-01 | 38,760 |
| 版本 | 发布日期 | 下载量 |
| 2.1 | 2025年3月15日 | 1.2万 |
| v2.0.0 | 2024-11-20 | 45320 |
| 1.9.5 | 24/08/01 | 约3.9万 |
错误示例中,版本号格式不统一(有的带 v 前缀,有的不带),日期格式混乱(中文格式、ISO 格式、缩写格式混用),下载量的表示方式也不一致。
表格中不得出现空白单元格
表格中的每个单元格都应有明确内容。如果某个单元格确实无数据,应填写"—"(破折号)或"N/A"来明确表示该项无数据,而非留空。空白单元格会让读者无法判断是数据缺失还是作者遗漏。
| 功能 | 免费版 | 专业版 |
| 基础编辑 | 支持 | 支持 |
| 协作功能 | — | 支持 |
| API 访问 | — | 支持 |
| 功能 | 免费版 | 专业版 |
| 基础编辑 | 支持 | 支持 |
| 协作功能 | | 支持 |
| API 访问 | | 支持 |
使用"—"明确表示该功能在免费版中不可用,避免读者误以为是信息缺失。
复杂表格应添加说明文字
当表格包含缩写、特殊符号或不易理解的内容时,应在表格下方添加注释说明。当表格数据来源于外部时,应标注数据来源和时间。
表格注释的常见写法:在表格下方使用"注:"开头,逐条说明缩写含义或特殊标记。例如:"注:√ 表示支持,× 表示不支持,△ 表示部分支持。"
优先使用简单表格结构
应尽量避免使用合并单元格(跨行或跨列)。合并单元格会降低表格的可访问性,也不利于响应式布局。如果信息层次复杂,建议将其拆分为多个简单表格,或使用标题分组来组织内容。
合并单元格对屏幕阅读器不友好,会严重影响视障用户的阅读体验。在需要符合无障碍标准的文档中,应避免使用合并单元格。