跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com

表格

最后更新 查看 MarkdownAgent 设置

使用表格简化内容和数据,为安排设计、结构、大纲、模式或顺序提供了一种全面的方法。它是进行对比、细分、列表、功能和描述的绝佳工具。

以下是创建表格的一些提示:

  • 标记列标题。
  • 如果适用,标记行标题。
  • 避免合并单元格。合并单元格会破坏屏幕阅读器导航,也更难被 AI 系统解析。
  • 避免文本过多。每个单元格的内容限制为一句话。
  • 力求列内格式和语气的平行(排比/一致性)。
  • 保持表格尽可能简单和紧凑。
  • 按逻辑顺序对行进行排序。如果不存在逻辑顺序,请使用字母顺序。
  • 使用描述表格用途的完整句子来引入表格,因为并非所有屏幕阅读器都会预先宣告表格。引入句可以以冒号或句号结尾;如果它紧邻表格上方,通常使用冒号,如果引入句和表格之间还有其他内容(例如提示段落),则通常使用句号。

引导句

使用描述表格用途的完整句子来引入表格,因为并非所有屏幕阅读器都会预先宣告表格。引入句可以以冒号或句号结尾;如果它紧邻表格上方,通常使用冒号,如果引入句和表格之间还有其他内容(例如提示段落),则通常使用句号。

在引用表格时,请使用像“下表”或“上表”之类的短语。不要将表格放在句子中间。

列标题

  • 使用句首字母大写。
  • 编写简洁且能清晰描述列内容的标题。
  • 不要以标点符号(包括句号、省略号或冒号)结束列标题。
  • 在 HTML 表格中使用 th 元素作为列标题。包含 scope 属性以确保可访问性。
<thead>
	<tr>
		<th scope="col">Name</th>
		<th scope="col">Description</th>
	</tr>
</thead>

表格位置

  • 将每个表格直接放在介绍它的句子之后。
  • 不要将表格放在有编号的操作步骤中间。将表格紧随相关步骤之后放置。
  • 如果表格有脚注,请将其紧随表格之后放置。

表格标题

如果页面仅包含一个表格,则不需要标题。将表格放置在引用它的文本附近。

如果页面在较近距离内包含多个表格,请为每个表格添加一个标题。以 表 NUMBER.(例如 表 1.)形式的编号开始,后跟简短描述。使用句首字母大写。不要在标题末尾放置句号。

在正文中引用带标题的表格时,请按编号引用——例如,“如表 2 所示”。除非是句首,否则不要将“表”字大写。

在 Markdown 中,将标题作为加粗行直接放在表格之前:

**Table 1.** Supported DNS record types

| Type | Description                      |
| ---- | -------------------------------- |
| A    | Maps a domain to an IPv4 address |
| AAAA | Maps a domain to an IPv6 address |

在 HTML 中,使用 caption 元素作为 table 元素的第一个子元素:

<table>
	<caption>
		<b>Table 1.</b>
		Supported DNS record types
	</caption>
	<thead>
		<tr>
			<th scope="col">Type</th>
			<th scope="col">Description</th>
		</tr>
	</thead>
	<tbody>
		<tr>
			<td>A</td>
			<td>Maps a domain to an IPv4 address</td>
		</tr>
	</tbody>
</table>

何时使用表格

表格的目的是提供可扫读的内容体验。表格用于显示具有某种关联的信息片段。

请在以下情况使用表格:

  • 数据和取值的简单映射
  • 带示例的事物类别
  • 具有不同属性的事物集合
  • 日期和描述,例如更新日志(changelog)
  • 带有属性的产品列表

何时不要使用表格

不要使用表格来对页面进行排版。

如果您的信息不符合这些指南,请考虑其他呈现方式:

Markdown 示例

添加表格

要添加表格,请使用三个或更多连字符 (---) 创建每列的标题,并使用竖线 (|) 分隔每一列。为了实现兼容性,您还应该在行的两端各添加一个竖线。

| Syntax      | Description |
| ----------- | ----------- |
| Header      | Title       |
| Paragraph   | Text        |

渲染后的输出如下所示:

语法 描述
表头 标题
段落 文本

提示:使用连字符和竖线创建表格可能会很繁琐。为了加快过程,请尝试使用 Markdown Tables Generator ↗。

对齐方式

您可以通过在表头行内的连字符左侧、右侧或两侧添加冒号 (:),将列中的文本对齐到左侧、右侧或居中。

| Syntax      | Description | Test Text     |
| :---        |    :----:   |          ---: |
| Header      | Title       | Here is this  |
| Paragraph   | Text        | And more      |

渲染后的输出如下所示:

语法 描述 测试文本
表头 标题 Here is this
段落 文本 And more

表格中的文本格式化

您可以格式化表格中的文本。例如,您可以添加链接、代码和强调。

您不能添加标题、块引用、列表、水平分割线、图像或 HTML 标签。

在表格中转义竖线字符

您可以通过使用 HTML 字符代码(“&#124;”)在表格中显示竖线 (|) 字符。

HTML 示例

对于复杂的表格,考虑使用 HTML。以下示例是使用 HTML 创建的:

字段描述
http.cookie
String

将整个 Cookie 表示为字符串。

示例值:
session=8521F670545D7865F79C3D7BEDC29CCE;-background=light

http.host
String

表示完整请求 URI 中使用的主机名。

示例值:
www.example.org ↗

大型表格

通常应避免在文档中使用大型表格。如果您有独特用例,请将表格包在 <table-wrap> 组件中,使其可响应并能够滚动。

Header 1 Header 2 Header 3 Header 4
test test test test
table-wrap exampletxt
<table-wrap>

| Header 1 | Header 2 | Header 3 | Header 4 |
| --- | --- | --- | --- |
| test | test | test | test |

</table-wrap>

这篇文档对您有帮助吗?