代码规范和格式

在整个 Cloudflare 产品内容中，使用下面描述的规范。

了解代码块格式化指南

使用尖括号来表示您希望用户输入的变量占位符（在 API URL 和 API 身份验证标头中除外，在这些地方您应该使用 $ZONE_ID / $CLOUDFLARE_API_TOKEN 格式）。占位符文本应全部大写，并使用下划线（_）分隔单词。

示例：

{
  "description": "<RULE_DESCRIPTION>"
}

https://<YOUR_DOMAIN>.cloudflare.com

包含由省略号分隔的数字的尖括号代表与位或单个名称关联的值范围 - 例如，AO <0...3>。

方括号用于包围可选项目。

示例：

指定以此搜索命令开头的子搜索：tag=dns query [search tag=malware]。

作为一般规则，请勿将花括号用于 URL 或变量占位符。相反，请参阅尖括号。

在引用特定 API 模式路径时，参数名称周围可以使用花括号（例如 /api/v4/{account_id}）。但是，在 API 示例（curl 块或 APIRequest 块）中，应改用 shell 变量（例如 $ACCOUNT_ID）。对于 API 操作的 URL 路径中的变量，APIRequest 组件会自动处理。有关更多信息，请参阅 cURL 命令指南。

>

符号引导您通过嵌套菜单项和对话框选项完成最终操作。序列 Options > Settings > General 指导您拉下 Options 菜单，选择 Settings 项，然后在最后一个对话框中选择 General。不要对 > 符号使用加粗格式。

此图标表示提示，用于向您发出建议性信息的警示。

此图标表示注释，用于向您发出重要信息的警示。

此图标表示信息，用于向您发出重要信息的警示。

此图标表示注意，用于警示您采取预防措施以避免数据丢失、信号完整性受损或性能下降。

此图标表示警告，用于建议您采取预防措施以避免人身伤害。

此颜色的文本表示链接。

在引用可点击的操作或为了在 UI 中突出显示标题或名称时使用加粗。加粗文本表示您必须在软件中选择或点击的项目、UI 中的标识符或参数名称。

不要对程序使用加粗。

在嵌套菜单中，对单词使用加粗，不要对符号使用加粗。

示例：仪表板 > This > That

当引用客户可以从中进行选择的选项时使用斜体，例如在下拉菜单中。

不要在引用开关状态时使用斜体 - 例如，不应对 enabled/disabled 使用斜体。

`反引号之间的文本`

此字体的文本表示您应从键盘输入的文本或字符、代码段、编程示例和语法示例。此字体也用于驱动器、路径、目录、程序、子程序、设备、函数、操作、变量、文件、API 命令和扩展的专有名词。