display in Matlab comments of functions or methods of classes in the console

7 次查看（过去 30 天）
Alessandro
Alessandro 2014-10-13
评论： Alessandro 2014-10-13
Hello is it possible in Matlab to show from the console the comments of a function ? For instance if I have a function like this:
%this is a function
function result = afunction()
blah = 2;
result = 21;
I would like to display the first lines of comments. In the console I would like to have something like this:
>> whatisdoing afunction
this is a function
Or even better if I could do this from matlab to display the comments of member methods from classes. I know there is the help command but it doesn t show the comments of functions.

请先登录，再回答此问题。

采纳的回答

Guillaume
Guillaume 2014-10-13
编辑：Guillaume 2014-10-13
help is actually the function you want. It does show the help (comments) of member function as well, as long as those comments are in the right location.
Put your comments after the
function result = afunction()
line, and help will show them.
For more details, see this help topic.
  2 个评论
Guillaume
Guillaume 2014-10-13
It works just as well for classes, class methods and class properties:
classdef myclass
%MYCLASS a description of my class
%This is a class for ...
properties
someprop; %someprop doc
end
methods
function out = somefunc(myclass)
%SOMEFUNC does something
%more information about SOMEFUNC
end
end
end
>>help myclass
>>help myclass.someprop
>>help myclass.somefunc

请先登录，再进行评论。

更多回答（0 个）

类别

在 Help Center 和 File Exchange 中查找有关 Class File Organization 的更多信息

标签

产品

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!

Translated by