http://www.perlmonks.org?node_id=50622


in reply to Re: Re: Planning your software before writing
in thread Planning your software before writing

In the business world it'd all go into a separate document. For a script I'd write to send out for other's to use on the net, it'd probably go in the code. In most cases though the documentation is long enough(and extensive) that it'd seem a waste of real estate to put it into the code as comments/pod IMHO. Its also more readable(and thus understandable) for me when its in word processor with a nice clear(slightly larger) font and pretty formatting.

I've also worked with scripts written by others that were so heavily commented that it would have been easier to understand without any comments at all. Everyone is slightly religious about how the prep work/documentation of their application is done..