[rt-users] Commenting PERL code in pm and MASON modules

[Ruslan Zakirov]

On Mon, Jan 24, 2011 at 5:37 PM, Wolfram Huettermann
<wolfram.huettermann at desy.de> wrote:
> Hello,
>
> I spent a week commenting PERL code in MASON modules and pm files. Having
> read some MASON modules, I was quite astonished that there was not almost
> any comment except th beginning one? So do you comment your MASON modules?
> Or do you put everything in a manual which could be an HTML file?

We don't put comments untill code is obviouse. comments are usable
when it's not clear why thing implemented this way and not differently
and may be more obviouse from a first glance.

.pm files are documented using POD and we would love to see patches
that cleanup or improve documentation for functions.


> I am looking forward to reading your replies.
>
> Greetings,
>
> Wolfram
>
>
>



-- 
Best regards, Ruslan.