3 Best Programming Practices

Recently I attended the online course provided by SkillSoft. One of the courses was Object-Oriented Programming Best Practices. I found there are 3 practices worth to be mentioned here.

1. Although you may provide your code in a clear, well organized format, and follow the best naming conventions, it is never possible to completely self-document your code. Therefore internal documentation a so should be provided, in addition to the self-documented code, in the form of comments. These comments are appended to the code they are documenting.  This internal documentation is the responsibility of individual software developers.


2. A strongly typed variable is one that can only be of one type. This type is established at compile time and always associated with the variable. Strongly typed variables are more difficult to misuse. If you attempt to place a string in a strong y typed integer variable, this will produce a type error at compile time. If a strongly typed variable holds more than one type, type misuse is captured at runtime.


3. It is good practice to list the input parameters first, then the working parameters, and finally the output parameters, so that you can tell at a glance what the method does. An alternative is to have a consistent order for methods that use the same set of parameters. Either way, you should document the function of each parameter, and its assumptions, as you write the method.



About chanmingman

Since March 2011 Microsoft Live Spaces migrated to Wordpress (http://www.pcworld.com/article/206455/Microsoft_Live_Spaces_Moves_to_WordPress_An_FAQ.html) till now, I have is over 1 million viewers. This blog is about more than 50% telling you how to resolve error messages, especial for Microsoft products. The blog also has a lot of guidance teaching you how to get stated certain Microsoft technologies. The blog also uses as a help to keep my memory. The blog is never meant to give people consulting services or silver bullet solutions. It is a contribution to the community. Thanks for your support over the years. Ming Man is Microsoft MVP since year 2006. He is a software development manager for a multinational company. With 25 years of experience in the IT field, he has developed system using Clipper, COBOL, VB5, VB6, VB.NET, Java and C #. He has been using Visual Studio (.NET) since the Beta back in year 2000. He and the team have developed many projects using .NET platform such as SCM, and HR based applications. He is familiar with the N-Tier design of business application and is also an expert with database experience in MS SQL, Oracle and AS 400.
This entry was posted in .Net, Community and tagged , . Bookmark the permalink.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )


Connecting to %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.