poster
2019-12-10, 20:48
这个问题与我的上一个问题有关： MATLAB m文件帮助格式 (https://stackoverflow.com/questions/3840657/matlab-m-file-help-formatting) 。
您通常写什么来描述您自己的函数的作者身份？您是将其放在函数主体的末尾还是在帮助文本之后的任何代码之前？
您如何包含版本信息？功能修改后是否可以自动更新版本？
这是我通常包括的内容：
% My Name % My company % Created: September 2010 % Modified: October 2010 请分享您的想法，想法？
回答：
我在MATLAB Central File Exchange中有一个功能 (http://www.mathworks.com/matlabcentral/fileexchange/27225-generate-a-new-function-m-file-with-documentation) ，可以帮助您以标准方式记录功能，并且可以与版本控制软件（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使用文件的哈希值，因此您无法更改文件的内容，除非git认为文件已更新。
更多&回答... (https://stackoverflow.com/questions/3840810)
您通常写什么来描述您自己的函数的作者身份？您是将其放在函数主体的末尾还是在帮助文本之后的任何代码之前？
您如何包含版本信息？功能修改后是否可以自动更新版本？
这是我通常包括的内容：
% My Name % My company % Created: September 2010 % Modified: October 2010 请分享您的想法，想法？
回答：
我在MATLAB Central File Exchange中有一个功能 (http://www.mathworks.com/matlabcentral/fileexchange/27225-generate-a-new-function-m-file-with-documentation) ，可以帮助您以标准方式记录功能，并且可以与版本控制软件（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使用文件的哈希值，因此您无法更改文件的内容，除非git认为文件已更新。
更多&回答... (https://stackoverflow.com/questions/3840810)