Beefy Boxes and Bandwidth Generously Provided by pair Networks
Your skill will accomplish
what the force of many cannot

Re: Re: Documenting Methods/Subs

by seattlejohn (Deacon)
on Jan 10, 2003 at 21:44 UTC ( #225971=note: print w/replies, xml ) Need Help??

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

I guess that if the person after you can ask you questions, don't comment it.

I have to disagree. What if you leave the company? What if you get run over by a bus? What if you decide to go on vacation (heaven forbid!) and trek around the Himalaya for two weeks?

Even if none of that happens, what happens when the code ships and gets forgotten, then someone decides to dust it off three years later? It's ancient history; will you really remember what you were thinking when you wrote it?

I suppose it's possible to go overboard with documentation, but I guess I find it much easier to ignore something that is there than to fill in something that isn't. I rarely trust myself to be able to remember my own thought process a couple of years down the road, let alone reconstruct somebody else's.

        $perlmonks{seattlejohn} = 'John Clyman';

Replies are listed 'Best First'.
assert(BusNumber > 1) (was Re3: Documenting Methods/Subs)
by dragonchild (Archbishop) on Jan 13, 2003 at 14:55 UTC
    What if you get run over by a bus?

    Maybe my tongue was a little too far in my cheek. *winces* I firmly hold that the "Bus Number" of any group should never be 1. (And, if anyone can come up with a link that doesn't involve TWiki re: Bus numbers, that would be great!)

    We are the carpenters and bricklayers of the Information Age.

    Don't go borrowing trouble. For programmers, this means Worry only about what you need to implement.

Log In?

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://225971]
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others perusing the Monastery: (6)
As of 2023-02-01 12:31 GMT
Find Nodes?
    Voting Booth?
    I prefer not to run the latest version of Perl because:

    Results (0 votes). Check out past polls.