A.1.13 Oct文件的文件编制和测试¶

oct文件的文档包含在的第四个字符串参数中defon_DLD宏。此字符串的格式可以与用户函数的帮助字符串的格式相同,但是存在一些问题,这些问题是oct文件中帮助字符串的格式化所特有的。

主要问题是帮助字符串通常比单行文本长,因此需要考虑长的多行帮助字符串的格式设置。有几种可能的解决方案,但最常见的在下面的例子中说明,

DEFUN_DLD(do_what_i_want,args,nar痛风,“-*-texinfo-*-\n\@deftypefn{}do_what_id_say(@var{n})\n\一个做用户实际想要的事情而不是他们指定的事情的函数。\n\@end deftypefn”){…}

其中每行文本以n其是字符串中嵌入的换行符以及C++字符串延续字符。注意,最后\必须是行上的最后一个字符。

Octave还包括将函数的测试和演示代码嵌入代码本身的能力(详见测试和演示函数). 这可以在oct文件(或者实际上任何文件)中使用,但有某些附带条件。首先,Octave的测试和演示函数查找%!作为一行的前两个字符来识别测试和演示代码。这也是oct文件的要求。此外,测试和演示代码必须包在注释块中,以避免编译器对其进行解释。最后,Octave测试和演示代码必须能够访问oct文件的原始源代码,而不仅仅是编译的代码,因为测试是从编译的代码中剥离出来的。oct文件中的一个示例可能是

/*%!断言(sin([1,2]),[sin(1),sin(2)])%！错误(sin())%！误差(sin(1,1))*/