注释与帮助系统 (GNU Octave(版本11.1.0))

2.7.3 注释与帮助系统¶

help 命令（参见获取帮助的命令）能够查找函数中的第一个注释块，并将其作为文档字符串返回。这意味着，用于获取内置函数帮助的命令同样适用于格式正确的用户自定义函数。例如，在定义下面的函数 f 之后：

function xdot = f (x, t)

# usage: f (x, t)
#
# This function defines the right-hand
# side functions for a set of nonlinear
# differential equations.

  r = 0.25;
  ...
endfunction

命令 help f 将产生以下输出：

 usage: f (x, t)

 This function defines the right-hand
 side functions for a set of nonlinear
 differential equations.

虽然可以将注释行放入键盘输入的一次性 Octave 程序中，但这通常用处不大，因为注释的目的是帮助您或他人在日后理解程序。

help 解析器目前仅识别单行注释（参见单行注释）作为初始帮助文本，不支持块注释。