---

1.3.5.1 示例函数描述 ¶

在函数描述中，首先出现的是被描述函数的名称。其后在同一行列出参数列表。参数名称也用于描述正文中。

在列举完所有的调用形式之后，下一行是该函数的一句话摘要。

在摘要之后，可能会有关于输入和输出的说明、函数使用示例、所用算法的注释以及对相关函数的引用。

下面是一个虚构函数 foo 的描述：

foo (x) ¶

foo (x, y) ¶

foo (x, y, …) ¶

计算 y 减 x，然后将所有剩余参数与结果相加。

输入参数 x 必须是数值标量、向量或数组。

可选输入参数 y 如果未提供，则默认为 19。

示例：

foo (1, [3, 5], 3, 9)
     ⇒  [ 14, 16 ]
foo (5)
     ⇒  14

更一般地，

foo (w, x, y, ...)
≡
x - w + y + ...

另请参阅： bar

任何名称中包含类型名称的参数（例如 integer 或 matrix）都应属于该类型。名为 object 的参数可以是任何类型。其他类型名称的参数（例如 new_file）会在函数描述中具体说明。在某些章节中，多个函数参数的共有特性会在开头进行描述。