Skip to content

Octave——function和commond

L edited this page Nov 3, 2017 · 1 revision

function

在功能描述中,首先描述正在描述的功能的名称。 在相同的行上跟随参数列表
在所有调用表单被枚举之后,下一行是简单的一句话的功能摘要
总结后可能会有输入和输出的文档,函数使用的例子,所使用算法的注释和相关函数的引用
举个栗子:
1.调用表单

: foo (x)  
: foo (x, y)  
: foo (x, y, …)  

2.功能摘要

从y中减去x,然后与剩余的参数相加得到结果。  
输入x必须是数字标量,向量或数组。  
如果未提供,则可选输入y默认为19。  

3.总结
举例:

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

更普遍,

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

4.合起来一个完整的功能描述就是:

: 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 + …

commond

commond没有参数
一个完整的commond描述:

: diary  
: diary on  
: diary off  
: diary filename  

记录所有命令及其生成的输出的列表,并将它们一起显示在终端上。
有效的选项有:
on
开始在当前工作目录中的一个名为日记的文件中记录会话。
off
停止在日记文件中记录会话。
filename
将会话记录在名为filename的文件中。
没有争议,日记切换了当前的日记状态。

Clone this wiki locally