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?

Practice

1. What does the help command do in MATLAB?

easy

A. Shows a short explanation of a function in the command window

B. Opens a detailed graphical documentation page

C. Runs the function with default parameters

D. Edits the function's source code

Solution

1. Step 1: Understand the purpose of help

   The help command is designed to show a brief explanation or summary of a MATLAB function directly in the command window.

2. Step 2: Compare with other options

   doc opens detailed documentation, running or editing functions is unrelated to help.

3. Final Answer:

   Shows a short explanation of a function in the command window -> Option A

4. Quick Check:

   help shows short explanation [OK]

Hint: Remember: help = quick info in command window [OK]

Common Mistakes:

• Confusing help with doc
• Thinking help runs the function
• Assuming help edits code

2. Which of the following is the correct way to open detailed documentation for the function plot?

easy

A. open plot

B. help plot

C. doc plot

D. run plot

Solution

1. Step 1: Identify the command for detailed documentation

   The doc command opens the detailed documentation page with examples and explanations.

2. Step 2: Check other options

   help shows short info, open and run are not used for documentation.

3. Final Answer:

   doc plot -> Option C

4. Quick Check:

   doc opens detailed docs [OK]

Hint: Use doc for detailed help with examples [OK]

Common Mistakes:

• Using help instead of doc for detailed info
• Trying to use open or run commands
• Forgetting to type the function name after doc

3. What will be the output of the command help sum in MATLAB?

medium

A. It will execute the sum function on the current workspace variables

B. It will display a brief description of the sum function in the command window

C. It will open the full documentation page for sum in a separate window

D. It will show an error because help cannot be used with sum

Solution

1. Step 1: Understand what help sum does

   The help command shows a short explanation of the specified function, here sum, in the command window.

2. Step 2: Eliminate incorrect options

   doc opens full docs, help does not execute functions or cause errors for built-in functions.

3. Final Answer:

   It will display a brief description of the sum function in the command window -> Option B

4. Quick Check:

   help shows brief info [OK]

Hint: help shows short info, doc shows full docs [OK]

Common Mistakes:

• Confusing help with doc
• Expecting help to run the function
• Thinking help causes errors for built-in functions

4. You typed helpplot in MATLAB but got an error. What is the likely problem?

medium

A. You forgot to put a space between help and the function name

B. The help command does not work for plotting functions

C. You need to use docplot instead

D. The function plot does not exist in MATLAB

Solution

1. Step 1: Analyze the command helpplot

   This is a single word, so MATLAB looks for a function named helpplot, which does not exist.

2. Step 2: Correct usage of help

   The correct syntax is help plot with a space to ask for help on the plot function.

3. Final Answer:

   You forgot to put a space between help and the function name -> Option A

4. Quick Check:

   Use space after help [OK]

Hint: Always put space between help and function name [OK]

Common Mistakes:

• Typing help and function name without space
• Assuming help doesn't work for plot
• Trying docplot instead of doc plot

5. You want to learn how to use the fft function with examples and detailed explanations. Which command should you use and why?

hard

A. Use edit fft to read the source code and understand usage

B. Use help fft because it shows detailed examples

C. Use run fft to execute the function and see results

D. Use doc fft because it opens full documentation with examples

Solution

1. Step 1: Identify the need for detailed explanations and examples

   Detailed explanations and examples are found in the full documentation, not in the short help text.

2. Step 2: Choose the correct command

   doc fft opens the full documentation page with examples, while help fft shows only brief info.

3. Step 3: Understand why other options are incorrect

   run fft executes the function, edit fft opens source code which may not be helpful for beginners.

4. Final Answer:

   Use doc fft because it opens full documentation with examples -> Option D

5. Quick Check:

   doc = detailed docs with examples [OK]

Hint: Use doc for full docs and examples, help for quick info [OK]

Common Mistakes:

• Using help expecting detailed examples
• Trying to run function to learn usage
• Editing source code instead of reading docs