matlabCommentTemplate

版本2.1.1(166 KB)
易于使用的m文件评论模板!

41下载

更新2022年9月23日

从GitHub

查看许可GitHub

视图matlabCommentTemplate文件交换”data-canonical-src=

Matlab函数和类评论模板

易于使用的m文件评论模板!自定义/预定义的评论模块为matlab函数和类。

如何安装

第一个直接双击”头。mlappinstall”然后右键单击“添加到快速访问工具栏”。
myimg”style=

如何使用

  1. 打开脚本文件你想评论;
  2. 使用快捷键“alt”+“1”或单击“标题”图标快速访问工具栏或类型的“头”命令窗口。

如何修改模板来满足您的需求?

输入这个命令行:编辑header.m,然后修改它。

例子

定义的函数或类文件在你的脚本(完全没有必要定义它,只需要函数原型签名),然后按下快捷键“alt”+“1”或单击“标题”标题的“快速访问工具栏”或类型在命令行窗口中。如果你不想自动插入注释在某些函数或类,您可以忽略它们通过以下开头的函数或类签名“%”。

  • 函数的例子
t=1:1。:2*π;y=(t);情节(t,y);函数=myfun1(一个,b,c)%简单:一行描述的函数或类执行%细节:%没有一个%%语法:%= myfun1 (a, b, c)%%输入:%a - [m、n]大小(双)类型,描述%b - m, n大小,(双)类型,描述%c - m, n大小,(双)类型,描述%%输出:%——(m, n)的大小,(双)类型,描述%%例子:%没有一个%%参见:没有%作者:yourname%电子邮件:youremail.com%创建:27 - 3月- 2022 20:13:59%版本历史修改记录:%没有一个%实现Matlab R2022a%版权©2022组织。保留所有权利。%=一个+b+c;结束函数=myfun2(argument1,argument2,……argument3,argument4,……argument5,argument6)%简单:一行描述的函数或类执行%细节:%没有一个%%语法:%= myfun2 (argument1, argument2、argument3 argument4, argument5, argument6)%%输入:%argument1 - [m、n]大小(双)类型,描述%argument2 - [m、n]大小(双)类型,描述%argument3 - [m、n]大小(双)类型,描述%argument4 - [m、n]大小(双)类型,描述%argument5 - [m、n]大小(双)类型,描述%argument6 - [m、n]大小(双)类型,描述%%输出:%——(m, n)的大小,(双)类型,描述%%例子:%没有一个%%参见:没有%作者:yourname%电子邮件:youremail.com%创建:27 - 3月- 2022 20:13:59%版本历史修改记录:%没有一个%实现Matlab R2022a%版权©2022组织。保留所有权利。%=argument1+argument2+argument3+argument4+argument5+argument6;结束
  • classdef例子
classdef电动机<ElectricVehicleComponent%简单:一行描述的函数或类执行%细节:%没有一个%%语法:%马达< ElectricVehicleComponent%%输入:%没有一个%%输出:%没有一个%%例子:%没有一个%%参见:没有%作者:yourname%电子邮件:youremail.com%创建:27 - 3月- 2022 20:16:17%版本历史修改记录:%没有一个%实现Matlab R2022a%版权©2022组织。保留所有权利。%属性CurrentSpeed=0速度范围=(0,180年]结束方法函数电动机=开始(电动机,速度)%简单:一行描述的函数或类执行%细节:%没有一个%%语法:%电动机=开始(电机、速度)%%输入:%电动机——[m、n]大小(双)类型,描述%速度——[m、n]大小(双)类型,描述%%输出:%电动机——[m、n]大小(双)类型,描述%%例子:%没有一个%%参见:没有%作者:yourname%电子邮件:youremail.com%创建:27 - 3月- 2022 20:16:17%版本历史修改记录:%没有一个%实现Matlab R2022a%版权©2022组织。保留所有权利。%参数电动机(1,1)电动机速度(1,1){mustBeReal,mustBeNonnegative}结束如果电动机CurrentSpeed>0错误(电动机:开始:MotorAlreadyRunning,……不能开始一个已经运行的电动机。)结束motor.CurrentSpeed=速度;结束函数电动机=停止(电动机)%简单:一行描述的函数或类执行%细节:%没有一个%%语法:%电动机=停止(电机)%%输入:%电动机——[m、n]大小(双)类型,描述%%输出:%电动机——[m、n]大小(双)类型,描述%%例子:%没有一个%%参见:没有%作者:yourname%电子邮件:youremail.com%创建:27 - 3月- 2022 20:16:17%版本历史修改记录:%没有一个%实现Matlab R2022a%版权©2022组织。保留所有权利。%如果电动机CurrentSpeed= =0错误(电动机:开始:MotorNotRunning,……不能阻止一个发动机不运行。)结束motor.CurrentSpeed=0;结束结束结束

引用作为

崔(2023)。matlabCommentTemplateGitHub (https://github.com/cuixing158/matlabCommentTemplate/releases/tag/v2.1.1)。检索

MATLAB版本兼容性
创建R2022a
兼容任何释放
平台的兼容性
窗户 macOS Linux

社区寻宝

找到宝藏在MATLAB中央,发现社区如何帮助你!

开始狩猎!

版本 发表 发布说明
2.1.1

GitHub上看到这个版本发布说明:<一个href="https://github.com/cuixing158/matlabCommentTemplate/releases/tag/v2.1.1" target="_blank" rel="nofollow noopener noreferrer">https://github.com/cuixing158/matlabCommentTemplate/releases/tag/v2.1.1

2.0

GitHub上看到这个版本发布说明:<一个href="https://github.com/cuixing158/matlabCommentTemplate/releases/tag/v2.0" target="_blank" rel="nofollow noopener noreferrer">https://github.com/cuixing158/matlabCommentTemplate/releases/tag/v2.0

1.1

GitHub上看到这个版本发布说明:<一个href="https://github.com/cuixing158/matlabCommentTemplate/releases/tag/v1.1" target="_blank" rel="nofollow noopener noreferrer">https://github.com/cuixing158/matlabCommentTemplate/releases/tag/v1.1

1.0

问题在这个视图或报告GitHub插件,参观<一个href="https://github.com/cuixing158/matlabCommentTemplate/issues" target="_blank" rel="nofollow noopener noreferrer">GitHub库
问题在这个视图或报告GitHub插件,参观<一个href="https://github.com/cuixing158/matlabCommentTemplate/issues" target="_blank" rel="nofollow noopener noreferrer">GitHub库