为类创建帮助
来自doc命令的帮助文本
当你使用医生命令显示类的帮助，MATLAB®自动显示从类定义派生的信息。
例如，创建一个名为someClass.m使用几个属性和方法，如下所示。
classdefsomeClass这门课的一些课程摘要放在这里这里有详细的解释属性一个%第一公共财产两个%第二公共财产结束属性(访问=私人)3%不显示此属性结束方法函数obj = someClass%建造商概述结束函数myMethod (obj)% myMethod的总结disp (obj)结束结束方法(静态)函数myStaticMethod% myStaticMethod概述结束结束结束
属性查看帮助文本和类定义中的详细信息医生命令。
医生someClass
自定义帮助文本
您可以添加关于您的类的信息医生命令和帮助命令包含在它们的显示中。的医生命令将帮助文本显示在生成的HTML页面的顶部，位于从类定义派生的信息之上。的帮助命令在命令窗口中显示帮助文本。更多细节,请参阅:
类
属性后面的行中包含注释，以创建类的帮助文本classdef文件中的语句。例如，创建一个名为myClass.m,如图所示。
classdefmyClass% myClass myClass的概要%这是myClass描述的第一行。%描述可以包含多行文本。％% myClass属性:% a - a的描述% b - b的描述％% myClass方法:% doThis - doThis的描述% doThat - doThat的描述属性一个b结束方法函数obj = myClass结束函数这么做(obj)结束函数doThat (obj)结束结束结束
初始注释块中的属性和方法的列表和描述是可选的。如果在注释行中后跟类名属性或方法和冒号(：)，然后MATLAB创建到属性或方法帮助的超链接。
控件在命令窗口中查看类的帮助文本帮助命令。
帮助myClass
myClass的总结myClass这是描述的第一行myClass．描述可以包含多行文本。myClass属性:一个-设备的描述b- b的描述myClass方法:这么做- doThis的描述doThat- doThat的描述
方法
通过在函数定义语句之后立即插入注释，为方法创建帮助。例如，修改类定义文件myClass.m包括帮助这么做方法。
函数这么做(obj)做这件事下面是doThis方法的一些帮助文本。％参见DOTHAT。disp (obj)结束
控件在命令窗口中查看方法的帮助文本帮助命令。指定类名和方法名，用圆点分隔。
帮助myClass.doThis
这么做这里有一些帮助短信这么做方法。另请参阅doThat．
属性
有两种方法可以为属性创建帮助:
在属性定义上方插入注释行。对多行帮助文本使用此方法。
在属性定义旁边添加单行注释。
定义上面的注释优先于定义旁边的注释。
例如，修改类定义文件中的属性定义myClass.m．
一个属性% myClass的第一个属性% b - myClass的第二个属性对b的描述有几个文本的%行。b%其他评论结束
属性在命令窗口中查看属性的帮助帮助命令。指定类名和属性名，用圆点分隔。
帮助myClass.a
a - myClass的第一个属性
帮助myClass.b
b - myClass的第二个属性b的描述有几行文本。
枚举
与属性一样，有两种方法可以为枚举创建帮助:
在枚举定义上方插入注释行。对多行帮助文本使用此方法。
在枚举定义旁边添加单行注释。
定义上面的注释优先于定义旁边的注释。
例如，在名为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 -第二个事件关于第二个事件的附加文本。
另请参阅
相关的话题
你也可以从以下列表中选择一个网站:
