in reply to Re: Documenting Methods/Subs
in thread Documenting Methods/Subs

I didn't mention anything about variable/function names etc. as I like to assume that every 'real' programmer tries to give sensible names to things to some degree.
After all, if someone comes with code like this:
my $a = $b - $c;
When what they meant was:
my $totaltime = $endtime - $starttime;
Then a usual response would be 'go away and write it so you understand it yourself in a years time, and then ask me again when it doesn't work'.

I agree completely about the data structures, the more so in perl where you can make hashes of arrays of hashes etc. I have some lovely ones which I wouldn't understand myself any more without the comments.
C.
*trying to maintain some code with 8-char indents, but thankfully sensible variable names and comments all over the place!*