文档使用说明

操作

• 点击跳转链接时，默认在当前标签页内跳转。使用 鼠标中键 来新建标签页访问；

• 搜索功能的服务配置有些问题，暂不可用；

• 点击右上角 可以将文档切换为深色模式，大多数图片也是以深色模式为主；

  • 我们对部分文档图片进行了优化，使其可以同时适配深色和浅色模式；

• 在左侧栏中选择你想阅读的文档；

• 点击代码块右上角按钮可以拷贝代码。

约定

站上的文本有各种各样的特殊格式，我们对它们表达的含义做出了一些约定。

粗体

表示强调或关键词。

斜体

表示 引用 或 人／团队名 或 加粗时二次强调。

跳转

跳转到站内其他位置，或当链接后跟有 ↗ 时，表示跳转站外链接。将鼠标悬停在其上有时会有和缩写一样的提示。

^角标

表示这只在对应环境中有效。

缩写

鼠标悬停或点击 ^触屏设备 可以查看缩写全称。

代码

表示这是程序运行时显示/日志/代码内容，或计算机行为。代码中内容的约定：

• <尖括号> ：由尖括号括起来的内容表示在这个区域内应该填写的内容。例： <文件名>.jpg ，其中 <文件名> 部分可以使用任意符合尖括号内定义的内容替换，例： 图片1.jpg。

• 在替换时应当将尖括号一同替换。

• [方括号] ：分为参数和数组两种情况。

• 表示函数中内容可选填入，例： smooth([id], val, [fadeInTime, [fadeOutTime]])。

• 在数组中，方括号不需要被一同替换，此时，例： float[a][b] 可以替换为 float[1][3]。

• 函数() ：函数分为原型和调用两种情况。

• 当函数和参数含有 变量类型 时，表示这是函数的原型 。例： float floor(float num)。

  • 有些函数有多个可以传入的变量类型，此时会在变量类型处使用 <尖括号> 。例如 min(<int|float> numA, <int|float> numB)。

• 当函数内参数仅有变量类型时，表示我们调用函数时会在这个函数内填何种参数。例： max(float, float)。

按键

表示这是键盘或者鼠标的按键

• AB 表示同时按下 A 和 B

• A, B 表示按顺序分别按下 A 和 B

• ^A 表示按住 A

公式

形如 的衬线内容，在部分设备上公式中的中文可能显示为非衬线字体，这些内容无法复制。