matlab文件的开头描述有没有一种约定俗成的格式？

如作者、版本号、最后修订时间等

当我搜索这个时，我只找到关于 comments themselves 的信息或 commenting the help text for functions .

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

在 mathworks 上我找到了关于 Contents.m file 的信息.使用时，它提供程序文件的摘要和版本号。你们中的任何人是否使用过此文件来包含额外的详细信息，例如作者身份、位置等？

我基本上只是在考虑其他约定，例如 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!");
    }
}

最佳答案

虽然函数开头注释的内容没有严格的标准(即 "Help text" )，但您应该了解一些关于它们的格式的特定事项em> 确定 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 时命令，这是默认搜索的第一个评论 block 的唯一部分。您必须添加 -all要搜索的整个帮助评论 block 的选项。因此，通常最好在此处放置关键描述词，以帮助人们搜索与某些操作相关的功能。

2) help 命令: 当使用 help 时，将显示函数中整个第一个连续的注释 block 。命令。对于上述示例，help addme将显示所有评论，包括“另请参阅...”行，但不会显示“其他一些评论...”行。

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

除了这几个注意事项之外，您还可以决定帮助文本应包含哪些内容。我通常错误地认为“越多越好”。 :)

https://stackoverflow.com/questions/38963119/