Wednesday, September 26, 2007

Importance of software documentation

I believe that in regard to this matter, are mostly ignored by software developers in Malaysia.
At the moment, I am to assist the rest of the Java developers team that are working on the eQuity Online internationalization (i18n) project. The thing that really bothers me and nearly made me scream out of anguish is the serious lack of code documentation and also of the quite poor design.

Although the system works fine and marvelously as one of our directors commented during a meeting I attended 2 weeks ago, I found that the code underneath was poorly written and poorly documented. And now we're going to modify it to support i18n and I am pulling my hairs and trying to figure out what each functions do and what's not.

For the love of God, at least put some sensible comment on the codes on what it do and at least provide the Javadoc. It can be auto-generated for God's sake! As if the mixture of scriptlets, html and javascript is not enough to add up the 'coolness' of the codes.

It's more than just spaghetti codes. It is a ball of mud!

So you guy out there whose works have anything to do with software development, do put some thought on this matter!

No comments: