---

1.3.5.1示例函数描述¶

在函数描述中,要描述的函数的名称首先出现。它在同一行后面是一个参数列表。用于参数的名称也用于说明的正文中。

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

在总结之后,可以有关于输入和输出的文档、函数使用的示例、关于所使用的算法的注释以及对相关函数的引用。

下面是一个虚拟的函数的描述foo:

: foo (x) ¶

: foo (x, y) ¶

: foo (x, y, …) ¶

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

参数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)在函数描述中进行了具体讨论。在某些部分中,几个函数的参数所共有的属性会在开始时描述。