2.7.3注释和帮助系统¶

这个帮助命令(详见用于获取帮助的命令)能够找到函数中的第一个注释块,并将其作为文档字符串返回。这意味着,用于获取内置函数帮助的相同命令可用于格式正确的用户定义函数。例如,在定义函数之后f在下面

函数xdot=f(x,t)#用法:f(x、t)##此函数定义一组非线性微分方程的右侧函数。r=0.25。。。结束函数

命令帮助f返回输出

用法:f(x,t)这个函数定义了一组非线性微分方程的右手边函数。

尽管可以将注释行放入键盘编写的丢弃Octave程序中,但这通常不是很有用,因为注释的目的是帮助您或其他人稍后理解该程序。

这个帮助解析器目前只识别单行注释(详见单行注释)并且不阻止草签帮助文本的注释。