如何将作者和版本信息包含在MATLAB函数中

Question

这个问题与我之前的问题有关:MATLAB m文件有助于格式化.

您通常用什么来描述自己职能的作者？你把它放在功能体的末尾还是在任何代码之前的帮助文本之后？

你如何包含版本信息？是否可以在功能修改后自动更新版本？

这就是我通常包括的内容:

% My Name <my@email>
% My company
% Created: September 2010
% Modified: October 2010

请分享您的想法,想法？

Answer 1

我在MATLAB中央文件交换中有一个功能,可以帮助您以标准方式记录您的功能,并使用版本控制软件(CVS和Subversion;而不是git)来自动更新作者字段和修改时间.

您只需new在命令提示符下键入,然后键入函数的名称,然后排除其余部分.

我使用的文档的基本模板是

function [outputArgs] = TestFunction(inputArgs)
%TESTFUNCTION Summary of this function goes here
% 
% [OUTPUTARGS] = TESTFUNCTION(INPUTARGS) Explain usage here
% 
% Examples: 
% 
% Provide sample usage code here
% 
% See also: List related files here

% $Author: rcotton $    $Date: 2010/10/01 18:23:52 $    $Revision: 0.1 $
% Copyright: Health and Safety Laboratory 2010

(您显然希望在您的版权声明中使用其他公司.)

帮助文档的第一行称为H1行,并由函数使用lookfor.重要的是,这在函数定义行之后是直接的.

如果您有不同的用例(可能有或没有可选参数),那么您应该描述每个用例.

在Examples:与 See also:线的方式与帮助报表生成作品格式化.(我刚刚发现了一个错误 - 那一年应该在版权行中的公司名称之前.修复它的方式.)

$Author:格式等用于CSV/SVN.由于git使用文件的哈希值,因此您无法更改文件的内容,而不会认为它已被更新.