Scilab中用户定义函数的文档

时间:2012-07-10 14:46:19

标签: documentation comments docstring scilab

我正在为学校完成一个Scilab项目,我根据the documentation的这段话添加了对我所有功能的评论:

  

在函数内部,第一条注释行,第一条指令或空行可用于提供函数帮助的默认内容。

但是,当我输入help时,help myfunction不会显示评论。相反,它会在搜索页面上启动帮助浏览器。

有什么想法吗?基本上我正在寻找相当于Matlab的“H1行”和“帮助文本”。

2 个答案:

答案 0 :(得分:1)

正确的指令是

head_comments myfunction

当没有名为myfunction的原生函数并且myfunction被称为用户定义的函数时,直接使用确实没问题

help myfunction

这个愿望被举报@http://bugzilla.scilab.org/10785

答案 1 :(得分:0)

您必须使用此功能将评论转换为帮助页面: http://help.scilab.org/docs/current/en_US/help_from_sci.html 然后编译它。