Illustration of script documentation, MATLAB Programming

Illustration of script Documentation:

For illustration, the script to compute the area of a circle could be modified to have comments:

2281_Illustration of script Documentation.png

The first comment at the starting of the script explains what the script does. Then, throughout the script, comments explain various parts of the script (not generally a comment for every line, though!). The Comments don't affect what a script does; therefore the output from this script would be similar as for the earlier version.

The help command in a MATLAB works with scripts as well as with the built-in functions. The initial block of comments (defined as adjacent lines at the starting) will be displayed. For illustration, for script1b:

>> help script1b

This program evaluates the area of a circle

The reason that a blank line was inserted in the script between the first two comments is that otherwise both would have been interpreted as one adjacent comment, and both lines would have been displayed with help. The very first comment line is known as the H1 line; it is what the function look for searches through.

Posted Date: 10/18/2012 5:45:53 AM | Location : United States







Related Discussions:- Illustration of script documentation, Assignment Help, Ask Question on Illustration of script documentation, Get Answer, Expert's Help, Illustration of script documentation Discussions

Write discussion on Illustration of script documentation
Your posts are moderated
Related Questions
How to Open Simpower: 1. Open MATLAB 2. In the "Command Window" write ' simulink ' and press Enter or click on the Simulink icon. 3. Simulink Library Browser w

Implement a MatLab function to calculate y.  The function should take two input arguments 1) A vector of parameters In the above example this would be of length 3, the first

A filter described by the equation:    y(n) = x(n) + x(n-1) + 0.9 y(n-1) - 0.81 y(n-2) (a) Find the transfer function H(z) for the filter and find the poles and zeros of the fil

Mathematical operation: For numerical operands, the use of such operators is clear-cut. For illustration, 3 >> 3 ans = 1 >> 9 ans = 0 Though, in the Wo

Design a controller which regulates flow and compensate pressure to my desire value in simscape.

A. Introduction The project consists of two parts. In the first part you are asked to perform some preliminary calculation and plotting, and to write the introduction for your

The purpose of this lab is to introduce students to the basic concept of overtones. In order to generate two tones at the same time, you need to generate two waveforms and add them

In this lab, we implement vectors, script and functions with plot. Plot function is used to plot the point into graph. These plots are handled by handle (h).  These handle is used

Example of Printing vectors: For vectors & matrices, even though formatting cannot be specified, the disp function may be simpler to use in common than fprintf as it displays