为了提高MATLAB中心文件交换上m文件文档的标准,我建议使用一个模板m文件头。
模板以H1行开始,后面几行更详细地描述函数的功能、调用语法、每个输入和输出变量的描述、函数使用的实际示例、有关运行此函数可能需要的其他m文件或mat文件的信息,以及“另请参阅”通向密切相关功能的线路。这将通过键入“help function_name”结束显示在命令窗口中的标题行块。
在空的未注释行之后,第二块注释行显示了作者的信息:姓名、职务、电子邮件、网站、文件创建日期和上次文件修改。最后,还有%---开始代码---行和%---结束代码---行。
我当然忽略了其他M-文件作者认为必要的信息。如果你有改进模板的建议,我会很高兴听到他们,我会尝试在未来的版本中包括他们。请不要在文件交换上单独提交此模板的相对较小的修改。仅当新提交(IMHO)在功能上进行重大更改时,才应考虑基于现有提交的文件交换上的新提交。
您应该编辑template_header.m并保存包含您自己个人信息的自定义版本,如template_dg.m所示。这将避免您在每次创建新m文件时重复键入作者信息。
引用为
丹尼斯·吉尔伯特(2021年)。M文件头模板(//www.tianjin-qmedu.com/matlabcentral/fileexchange/4908-m-file-header-template),MATLAB中央文件交换。恢复.
MATLAB版本兼容性
用R13创建
与任何版本兼容