Installation guide

7 Tuning and Managing M-Files

Description

With Description selected, the Help Report displays the first lin e of help in

the M-file. If the first comment line is empty, or if there is not a comment

before the executable code, No description line, highlighted in pink, appears

instead.

Examples

With Examples selected, the Help Report displays the line number w here the

examp le s section of the M-file help be gins. The Help Report loo ks for a line in

the M-file help that begins w ith the string

example or Example and displays

any subsequent nonblank comment lines. Select this op ti on to easily locate

and go to examples in your M-files.

It is a g ood practice to include ex amples i n the help for your M-files. If you do

not have examples in the help for all your M -files, use this option to identify

those w itho ut examples. If the report do es not find examples i n the M-file

help, No example, highlighted in pink, appears.

Show All Help

With Show all help selected, the Help Report displays complete M-file help,

which is all contiguous nonexecutable lines (comment lines and blank lines),

starting with the second line of a function M-file, or the first line of a script

M-file. The M-file help shown also includes overloaded functions a nd methods,

which are not actually part of the M-file help comments, but are automatically

generated when

help runs.

If the comment lines before the exe cutable code are em pty, or if there are no

comments before the executable co de, No help, highlighted in pink, appears

instead.