Re: Help with my Coding Style - another chance to critique

I'll admit that I didn't take the time to read through your code carefully, but right off the bat I see two problems:

No comments
No POD documentation

Commenting will help you understand your code better, now and when you return to it in a year. POD will help other programmers use your modules. In the case of a CGI::Application module the POD is a good place to put an example stub and describe any configuration parameters (PARAMS) you support.

-sam

Comment on Re: Help with my Coding Style - another chance to critique

Replies are listed 'Best First'.
Re: Re: Help with my Coding Style - another chance to critique by belg4mit (Prior) on Jul 02, 2002 at 17:57 UTC
These are not prerequisites for good programs, this code is quite self-explanatory without them. This is my own reaction of course, from someone who comments very little. To each is own. `-- perl -pew "s/\b;([mnst])/'$1/g"`	[reply]
Re: Re: Re: Help with my Coding Style - another chance to critique by samtregar (Abbot) on Jul 02, 2002 at 19:27 UTC
No code is self-explantaory! Code only says "how." Good code can also explain "what." It is generally impossible for code, no matter how good, to properly document "why." The "why" of a program is crucial to maintainability, which is a critical property of good programs. A good program that is hard for others to maintain isn't really very good given time. -sam	[reply]