Question

是否有编写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!");
    }
}

Answer 1

Matlab没有强制执行，但有一个，并在此提供了一个基本示例：http://uk.mathworks.com/help/matlab/matlab_prog/add-help-for-your-program.html

帮助您检查是否添加了适当文档的有用命令是helprpt。如果您缺少帮助标题，或者您的帮助标题缺少examples / see also语法等，它会告诉您。 编辑：这已被2016a的图形菜单所取代;见here。另请查看codetools 。

此外，Octave在八度音阶手册中定义something similar，以及coding style in general的一些有用指南; （我发现这种风格非常整洁，我推荐它。）

一般来说，无论是在matlab还是在八度音阶中，都会在所有m文件中保持一致的风格;如果你从发行版中打开任何m文件并模仿样式，你就会做对。

Answer 2

不，没有＆＃34;官方＆＃34; /＆＃34;普遍＆＃34;标准。您可以选择任何您想要的约定，或推出自己的约定。一旦你决定了你的评论的样子，那么保持一致并坚持下去是一个好主意。

通常，至少对于大多数内置函数，您将找到1.简短描述，然后是2.使用语法，3。更全面的描述和4.相关函数。

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

2 个答案: