是否存在用于编写matlab文件的开始描述的常规格式?
例如包括作者、版本号、最后修订日期等。
当我搜索这个时，我发现的都是关于注释本身或注释函数的帮助文本的信息。
EDIT:
为了澄清，我想知道是否有一个地方可以放置整个模拟的作者身份细节?即:不是功能描述/帮助文本的文本(这也是非常有用的，感谢您提供的详细信息)。
在数学作品中，我找到了关于内容的信息。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!");
}
}
虽然对于函数的开始注释的内容没有严格的标准(即"帮助文本")，但是您应该了解有关其格式的一些具体内容，这些内容决定了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将显示直到并包括"See also…"的所有注释。行，但不会显示"Some other comment…"行。
3)到其他函数的超链接:如果您想在帮助文本中包含到相关函数的超链接，您可以在帮助文本的末尾添加% See also行，后面跟着这些函数的名称。对于上面的示例，输入help addme将显示带有sum和plus函数链接的帮助文本，单击这些链接将依次显示这些函数的帮助文本。
除了这几个注意事项之外，您可以决定帮助文本应该包含什么内容。我通常倾向于"越多越好"。:)
Matlab不强制一个，但它确实有一个，并在这里提供了一个基本的例子:http://uk.mathworks.com/help/matlab/matlab_prog/add-help-for-your-program.html
helprpt是一个有用的命令，可以帮助您检查是否添加了适当的文档。如果你缺少一个帮助头，或者你的帮助头缺少examples/see also语法等，它会告诉你。编辑:这在2016年已经被图形菜单所取代;在这里看到的。还可以查看codetools。
此外，Octave在Octave手册中定义了一些类似的东西，以及一些关于一般编码风格的有用指南;(我觉得这个款式很整洁，我推荐它)。
一般来说，在matlab和octave中，在所有的m文件中都保持一致的风格;如果您打开发行版中的任何m文件并模仿其样式，您就会得到正确的结果。
没有，没有"官方"/"通用"的标准。你可以选择任何你想要的惯例，或者推出你自己的惯例。一旦你决定了你想让你的评论看起来像什么，保持一致并坚持下去是一个好主意。
通常，至少对于大多数内置函数，您将找到1。一个简短的描述，后面跟着2。用法语法，3。更全面的描述和4。相关函数。
要查看示例，在MATLAB中运行此命令:
edit fft
顺便说一下，正如@DanielG所说，没有官方的/通用的标准。