Help system and documentation in MATLAB - Cheat Sheet & Quick Revision

Recall & Review

beginner

What command in MATLAB shows the documentation for a specific function?

The help command displays the documentation for a specific function in the Command Window. For example, help plot shows help for the plot function.

beginner

How do you open the full MATLAB documentation browser?

Use the doc command to open the full MATLAB documentation browser. For example, doc plot opens detailed help for the plot function in a separate window.

beginner

What is the difference between help and doc in MATLAB?

help shows a brief description of a function in the Command Window, while doc opens the full, detailed documentation in a separate window with examples and links.

intermediate

How can you add your own help text to a MATLAB function?

Add comments at the very beginning of your function file. These comments become the help text shown when users type help yourFunction. The first contiguous block of comments is used for help.

intermediate

What command shows a list of all functions in a MATLAB toolbox?

Use help toolboxname to see a list of all functions in that toolbox. For example, help signal lists functions in the Signal Processing Toolbox.

Which MATLAB command opens detailed documentation in a separate window?

A type

B doc

C lookfor

D help

doc opens the full documentation browser with detailed info and examples.

What does the help command display?

A Brief description in Command Window

B Full documentation in a window

C List of all functions

D Source code of a function

help shows a short description in the Command Window.

How do you add help text to your own MATLAB function?

A Write comments at the start of the function file

B Use the <code>doc</code> command

C Create a separate text file

D Use the <code>help</code> command inside the function

Comments at the top of the function file become the help text.

Which command helps find functions by keyword in MATLAB?

A help

B doc

C lookfor

D which

lookfor searches all help text for a keyword.

What command shows the source code of a MATLAB function?

A doc

B help

C lookfor

D type

type functionName displays the source code in the Command Window.

Explain how to access help and documentation for a MATLAB function.

Think about quick help vs detailed help.

Describe how to write your own help text for a MATLAB function so others can understand it.

Where do you put comments to show help?