Skip to main content

FundaTip1 : Script File

Why commenting is important in programming?


While writing a program in script file, it is always recommended to add comments. Comments will help reader to understand following things  -
  1. Project title and details about the same. 
  2. Purpose of variables used, in mathematical equations. 
  3. Declaration of given data variables. 
  4. Units of the given variable and output variable. 
  5. Assumptions made while working with mathematical model in your project.
Let's take a look at the example below - 

A program without comments. 


In the example above we are not able to understand what is tC, CwT or rC. Even with oak and pine variables, its difficult to understand why those values? And what is its unit? What is the goal of the program? 

But with comments reader can easily understand the purpose of program, goal of a programmer, the units of variable and nomenclature of input variables.

A program with comments.


A program with simple comments is very much easy to understand.

This will very much help you in your projects, when a project duration is across a year and when you want to refer your own first programs.

Try best practice and be a pro-programmer with simple and easy tips and tricks. 

Labels:

Comments

Post a Comment

Popular posts from this blog

MATLAB Programs - Numerical Methods and Optimization

Roots of Equation - BiSection Method Bisection method is one of the numerical methods to find roots of the equation, included in the syllabus of Third Year Mechanical Engineering course for colleges under University of Pune. The bisection method in mathematics is a root-finding method that repeatedly bisects an interval and then selects a subinterval in which a root must lie for further processing. It is a very simple and robust method, but it is also relatively slow. Because of this, it is often used to obtain a rough approximation to a solution which is then used as a starting point for more rapidly converging methods. Let us consider an example  Figure 1: Polynomial function in f(x)=0 form. To solve polynomial function, it has to be converted into f(x) = 0 form, where all the terms containing powers of x and constant should be on the left-hand side of the equal to sign. Create a function file in MATLAB as shown in figure 1, having a polynomial equation in...
Post a Comment
Read more

Welcome to my blog!

Dear fellow engineers, w elcome to the bog MATLAB Tips & Tricks. This blog is all about interesting tips and tricks that are useful in MATLAB and Simulink, for quick and efficient programming. Generally experts and coders with more experience use them to get done with codes or mathematical models in Simulink. MATLAB being a mathematical programming environment, it is used by researchers, academicians and industry professionals. Because of the tools which are present in MATLAB, makes it more versatile and useful for wide range of applications.  Rupesh Gosavi started his practice with MATLAB in the year of 2013, during his post-graduation. With this blog he wants to spread the knowledge of MATLAB and Simulink, which he gained over the practice of more then 7 years. He is holding a graduation degree in mechanical engineering and post-graduation in automobile technology. During his post-graduation studies, he found MATLAB being a most interesting, dynamic and research oriented l...
Post a Comment
Read more

FundaTip2 : Script File

Simple visual trick to minimize errors in your program.  We often encounter various errors while programming. Sometime it is very difficult to find, if the error is manual. I would like to share a trick to avoid the programming errors while writing a program in script file or function file. Consider a simple example of "Finding sum of first 'n' numbers." Following are the recurring errors we may encounter while programming - You can check with Top-Right Corner of script/function file. The red color box represents the syntax error. The horizontal line below that makes it easier for us to find error command. Error 1: Check with correct function file syntax to avoid this error (parenthesis). Error 2: No other command is allowed before function command. Error 3: End statement is missing. Warnings in the script/function file is denoted by orange color box. Warning is a suggestion by MATLAB to make program execute quicker. When warni...
Post a Comment
Read more