是否有编写matlab文件开头注释的标准？

Question

是否有用于编写matlab文件的开头描述的传统格式？

如包括作者,版本号,最新修订版等.

当我搜索这一切时,我发现是评论本身的信息或评论函数的帮助文本.

编辑:
为了澄清,我想知道是否有一个地方可以放置整个模拟的作者详细信息？即:不是功能描述/帮助文本的文本(这也是非常有用的,非常感谢大家提供详细信息).

在mathworks上,我找到了有关Contents.m文件的信息.使用时,它提供程序文件和版本号的摘要.您是否有人使用此文件来包含诸如作者身份,位置等额外细节？

我基本上只是考虑其他约定,例如在Java中(我不是要比较两者,而只是为了补充说明我正在寻找的内容):

/**
* The Foo program displays Hello World!
*
* @author  J Smith  << A place to put these details?
* @version 1.0
* @since   2016-08-23
*/
public class Foo {
    public static void main(String[] args) {
        System.out.println("Hello World!");
    }
}

Answer 1

虽然对函数的开始注释(即"帮助文本")的内容没有严格的标准,但是您应该知道一些关于其格式的具体事项,以确定MATLAB将如何使用或显示它们.让我们从这个示例开始:

function c = addme(a,b)
% ADDME  Add two values together.  <---- H1 line
%   C = ADDME(A) adds A to itself.
%   C = ADDME(A,B) adds A and B together.
%
%   See also SUM, PLUS.

% Some other comment...

switch nargin
  case 2
    c = a + b;
  case 1
    c = a + a;
  otherwise
    c = 0;
end

1)H1行:这是第一个注释行,这是当前文件夹浏览器或lookfor命令将显示的内容.使用该lookfor命令时,这是默认搜索的第一个注释块的唯一部分.您必须为-all要搜索的整个帮助注释块添加选项.因此,在这里放置关键描述性词语通常是一个好主意,以帮助人们搜索与某些操作相关的功能.

2)help命令:使用help命令时,将显示函数中第一个连续的连续注释块.对于上面的示例,help addme将显示所有注释,包括"另请..."行,但不会显示"其他注释..."行.

3)超链接到其他功能:如果您想在帮助文本中包含指向相关功能的超链接,可以在帮助文本% See also的末尾添加该行,然后添加这些功能的名称.对于上面的示例,键入help addme将显示带有sum和plus函数链接的帮助文本,单击这些链接将依次显示这些函数的帮助文本.

除了这几个注意事项外,您还需要确定您的帮助文本应包含哪些内容.我一般都对"越多越好"这一方面犯错.:)