尝试在官方文档中的其他部分。它更彻底。 MATLAB>用户手册>桌面工具和开发环境>自定义帮助和演示>提供您自己的帮助和演示。这描述了简单的帮助文本和生成单独的HTML帮助文件。
这里是我选择的帮助文本格式,并发现有用。
function foo(x,y,z)
%FOO One-line description goes here
%
% foo(x,y,z)
%
% Multi-line paragraphs of descriptive text go here. It's fine for them to
% span lines. It's treated as preformatted text; help() and doc() will not
% re-wrap lines. In the editor, you can highlight paragraphs, right-click,
% and choose "Wrap selected comments" to re-flow the text.
%
% More detailed help is in the <a href="matlab: help foo>extended_help">extended help</a>.
% It's broken out like this so you can keep the main "help foo" text on
% a single screen, and then break out obscure parts to separate sections.
%
% Examples:
% foo(1,2,3)
%
% See also:
% BAR
% SOMECLASS/SOMEMETHOD
disp(x+y+z);
function extended_help
%EXTENDED_HELP Some additional technical details and examples
%
% Here is where you would put additional examples, technical discussions,
% documentation on obscure features and options, and so on.
error('This is a placeholder function just for helptext');
- 函数签名后的第一行被称为“H1线”。它需要只是一行,因此它可以由contentrpt()正确拾取,它可以从函数中的帮助文本自动生成Contents.m文件。
- H1行中的函数名称全部为大写,无论实际大写在签名中的函数名称
- “另请参见”的情况。我不确定哪些案件都有效;这个确实如此。
- “另请参阅:”后的函数名称全部大写。方法名称是合格的;我认为与当前方法在相同类中的方法名称可能是不合格的。
H1行与“Examples:”之间的所有内容都是我发现可读的传统格式; help()不会专门处理它。
您可以在帮助中使用有限形式的超链接。特别是,您可以使用超链接来调用任意的Matlab命令,并通过调用help()指向helptext的其他部分。你可以用它来指向任何函数; “function> subfunction”只是在help()调用中寻址子函数的语法。不幸的是,由于您需要在这些超链接中放置“帮助”或“文档”,它只能以一种或另一种表示形式工作。如果有一个直接的helptext超链接表单,会更好。
您添加第二个环节正是我正要建议。那里非常有用的东西。 – gnovice 2010-10-01 16:52:22
你应该把你的UPDATE作为答案,并接受它! – 2010-10-01 16:57:57
@Alex,我打算收集关于m文件格式的信息。创建单独的文档只是一个侧面问题。 – yuk 2010-10-01 18:42:35