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

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.

Answer 1

[Guillaume]

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.

[Guillaume]

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

[Alessandro]

You are right ! thanks