Beefy Boxes and Bandwidth Generously Provided by pair Networks
good chemistry is complicated,
and a little bit messy -LW
 
PerlMonks  

Re: Too much documentation?

by LD2 (Curate)
on Aug 14, 2001 at 08:55 UTC ( [id://104676]=note: print w/replies, xml ) Need Help??


in reply to Too much documentation?

I don't think there is anything wrong with too documentation, if anything... there is something wrong with too less documentation (I know, bad grammer.. but you get the gist). Documentation doesn't slow code down - but it does make it understandable to those who must follow in your footsteps later to maintain it. Even if you maintain that code, months later you may forget exactly what you're trying to do in a certain function or whatnot - and documenation helps trigger the memory or explain it completely. Although many programmers detest documentation or documenting their own code - it's something that they're rather thankful when inheriting a project. It doesn't take too much effort and it saves time down the road... here are a few other nodes that have talked about documentation. Check out use documentation; and Danger, danger Will Robinson (documenting code).

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others examining the Monastery: (4)
As of 2024-04-25 16:31 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found