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
need help in my accounts help

Simulation of a transmission system with a 4-fsk modulation scheme; using non-coherent detection method and an awgn channel. System description: 1. Input: A. Random binary

hi, I would like to get quote for my matlab assignment help? thanks


how to convert char array to a string cell

Illustrations of if statement: illustrations of running this script: >> sqrtifexamp Please enter a number: -4.2 The sqrt of 4.2 is 2.0 >> sqrtifexamp Please ent

Function definitions: There are various ways to organize the scripts and functions, but for now every function which we write will be stored in a separate M-file, that is why

how to control a suspension by linear quadratic regulator method?

Function char: The function char does the opposite; it converts from any number type to the type char: >> char(numequiv) ans = a As the letters of the alphabet are

Matlab Command Reference 1. Getting Help: The help command is used to find the functions and its syntax. Similarly, lookfor is used to find the functions or topics. For examp