MATLAB Programming

Help
Writing Your Own Help
Start each program you write with a section of text providing help on how and
when to use the function. If formatted properly, the MATLAB help function
displays this text when you enter
help functionname
MATLAB considers the first group of consecutive lines immediately following
the function definition line that begin with % to be the help section for the
function. The first line without % as the left-most character ends the help.
For more information: SeeHelpTextintheMATLABDesktopToolsand
Development Environment documentation.
Help for Subfunctions and Private Functions
You can write help for subfunctions using the same rules that apply to main
functions. To display the help for the subfunction mysubfun in file myfun.m,
type
help myfun>mysubfun
To display the help for a private function, precede the function name with
private/. Toget help on private function myprivfun, type
help private/myprivfun
Help for Methods and Overloaded Functions
You can write help text for object-oriented class methods implemented with
M-files. Display help for the method by typing
help classname/methodname
where the file methodname.m resides in subdirectory @classname.
For example, if youwriteaplot method for a class named polynom, (where
the plot method is defined in the file @polynom/plot.m), you can display
this help by typing
help polynom/plot
12-9