我a function在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:
行的格式与帮助报告生成器一起使用。 (我刚刚发现了一个bug - 年份应该在版权行中的公司名称前面),请修复此问题。
$Author:
等格式化为与CSV/SVN一起使用。由于git使用文件散列,因此不能更改文件的内容,而不会考虑git已更新。
哦,整合SVN整合工作(+1酷) !我不完全确定这些信息如何有用,只要我可以看看'svn log',但是我应该将它包含在我的函数模板中,以获得绝对的冷静。 $ author字段用修改函数的最后一个人更新,对吗? – Jonas 2010-10-01 20:40:59
嗯,我是否需要更改SVN中的设置才能更新Author字段等? – Jonas 2010-10-01 20:54:41
@Jonas:当您提交更改时,svn字段会更新,但您需要执行svn propset svn:keywords“Date Author Revision”filename.m'来配置它。请参阅http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html。作者字段是当前用户的操作系统登录名。 – 2010-10-04 09:34:21