Beefy Boxes and Bandwidth Generously Provided by pair Networks
Perl Monk, Perl Meditation

Re: Preferred method of documentation?

by buttroast (Scribe)
on Oct 09, 2004 at 19:43 UTC ( #397896=note: print w/replies, xml ) Need Help??

in reply to Preferred method of documentation?

In college they told us that in the "real world", you have to have

two versions of each function; the actual function code itself, and at the top of the function, the entire function written in pseudocode.

I found this to be extremely redundant, especially since the code was written in COBOL. Nowadays, I stick with the good comments throughout the code, but I only use them to explain the logic, not necessarily the code.

I've seen some functions that have comments explaining what each piece of code does. This is fine if someone who doesn't know the language will be maintainting it (Why?), but that's also what the programming language's documentation is for.

In closing, don't try to document the language, stick with documenting the logic, and let the maintainer learn the language somewhere else.

Thanks buttroast

Log In?

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

How do I use this? | Other CB clients
Other Users?
Others lurking in the Monastery: (2)
As of 2021-10-20 04:18 GMT
Find Nodes?
    Voting Booth?
    My first memorable Perl project was:

    Results (78 votes). Check out past polls.