In Depth Software Development Strategies, Tip 1: Commenting

Posted by

I've spent the past couple of days learning a new computer language, PHP. I'm currently in the process of developing an online management system, and after a careful anaylsis PHP appeared to be the right language to develop with.

So I have been going through some tutorials and looking at lots of coding examples. As a pretty experienced programmer, I am still having a hard time understanding some code developed by other people.

Which leads me to the first tip in this series.

The following coding tip is very straight forward, but ESSENTIAL to keeping you effective in the Information Technology Industry, especially when working in a team environment

1. Comment your code:

If anyone is going to be reviewing your code at any point in time, you should always leave appropriate commets to help guide them. Here is how I structure my commenting, lets use JAVA for this example

/////////////////////////////////////////

// Title of Program Author's Name

// Date of creation

//

// Breif description of the program

/////////////////////////////////////////
public class TestClass

{

// Variables

protected int iCounter;

// Here is where you would list all your global variables
// Methods List all the methods after this for good program structure
////////////////////

// main (String args [])

// Do: What is the main function of this method

// Input: What is brought into the method

// Returns: What the method returns

public static void main (String args [])

{

//

} // End main Method -> Keep track of your end brackets with a small comment

} // EndTestClass
Commenting while you are developing does not take a lot of time, and it will definitely pay off for you later, especially when you try to review some complex code.

Leave a Reply

Your email address will not be published. Required fields are marked *