创建帮助类
帮助文本文档的命令
当你使用医生命令显示帮助类,MATLAB®自动显示信息来源于类定义。
例如,创建一个类定义文件命名someClass.m与一些属性和方法,如图所示。
classdefsomeClass% someClass总结这个类的就在这里%的详细解释属性一个%的第一个公共财产两个%第二公共财产结束属性(访问=私人)3%不显示这个属性结束方法函数obj = someClass%总结构造函数结束函数myMethod (obj)%总结myMethoddisp (obj)结束结束方法(静态)函数myStaticMethod%总结myStaticMethod结束结束结束
查看帮助文本和类定义使用的细节医生命令。
医生someClass
自定义帮助文本
您可以添加信息两类医生命令和帮助命令包括在他们的显示。的医生命令显示顶部的帮助文本生成的HTML页面,上面的信息来自类定义。的帮助命令在命令窗口中显示帮助文本。更多细节,请参阅:
类
创建帮助文本类,包括评论线后classdef声明在一个文件中。例如,创建一个文件命名myClass.m,如图所示。
classdefmyClass% myClass myClass的总结%的第一行myClass的描述。%可以包括多行文本描述。%% myClass属性:% - - -描述% b - b的描述%% myClass方法:%就是——做的描述% doThat——doThat的描述属性一个b结束方法函数obj = myClass结束函数这么做(obj)结束函数doThat (obj)结束结束结束
的属性和方法列表和描述最初的注释块是可选的。如果将包含类名后面的注释行属性或方法和一个冒号(:),然后用MATLAB的帮助创建超链接属性或方法。
视图类的帮助文本在命令窗口中使用帮助命令。
帮助myClass
myClass的总结myClass这是第一行的描述myClass。描述可以包含多行文本。myClass属性:一个——描述一个b- b的描述myClass方法:这么做——描述做的doThat——描述doThat
方法
通过插入评论后立即创建方法的帮助函数定义语句。例如,修改类定义文件myClass.m包括帮助的这么做方法。
函数这么做(obj)%就是做这件事的%这里是一些帮助文本做的方法。%%参见DOTHAT。disp (obj)结束
查看帮助文本在命令窗口中使用的方法帮助命令。指定类名和方法名称,由一个点。
帮助myClass.doThis
这么做做这件事的是一些帮助文本这么做方法。另请参阅doThat。
属性
有两种方法可以创建帮助属性:
插入注释行上面的属性定义。使用这种方法为多行文本的帮助。
添加一个旁边的单行注释属性定义。
上面的评论旁边的定义有优先于评论的定义。
例如,修改属性定义在类定义文件中myClass.m。
一个属性% myClass的第一属性% b - myClass的第二属性% b的描述有几个%的文本行。b%其他评论结束
查看帮助在命令窗口中使用属性帮助命令。指定类名和属性名,由一个点。
帮助myClass.a
- - - - - - myClass的第一特性
帮助myClass.b
b - b myClass的第二个属性描述几行文本。
枚举
像属性一样,有两种方法可以创建枚举的帮助:
插入注释行上方的枚举定义。使用这种方法为多行文本的帮助。
添加枚举定义一个单行注释。
上面的评论旁边的定义有优先于评论的定义。
例如,创建一个枚举类文件中命名myEnumeration.m。
classdefmyEnumeration枚举uno,%的第一个枚举% DOS——第二个枚举%的描述DOS有几个%的文本行。dos%的评论(不是帮助文本)结束结束
查看帮助在命令窗口中使用帮助命令。指定类名和枚举成员,由一个点。
帮助myEnumeration.uno
uno——第一个枚举
帮助myEnumeration.dos
dos——第二枚举dos的描述几行文本。
事件
如属性和枚举,有两种方法可以创建帮助事件:
插入注释行事件定义。使用这种方法为多行文本的帮助。
添加一个单行的评论事件定义。
上面的评论旁边的定义有优先于评论的定义。
例如,创建一个类文件中命名hasEvents.m。
classdefhasEvents <处理事件α%第一个事件%β-第二个事件%关于第二个事件附加文本。β%(不是帮助文本)结束方法函数fireEventAlpha (h)通知(h,“α”)结束函数fireEventBeta (h)通知(h,“β”)结束结束结束
查看帮助在命令窗口中使用帮助命令。指定类名和事件,由一个点。
帮助hasEvents.Alpha
α-第一个事件
帮助hasEvents.Beta
β-第二个事件关于第二附加文本事件。
