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

Re: Maxims for Programmers

by mem (Acolyte)
on May 19, 2002 at 09:35 UTC ( [id://167627]=note: print w/replies, xml ) Need Help??


in reply to Maxims for Programmers

No amount of documentation is a good enough substitute for the source code.

Pet peeve alert! That's true, but undocumented source code is as bad. I don't mean stuff like my $count; # particle hit count, but design documentation. I've dove into undocumented source code too many times, extracting flow control diagrams, drawing data structures, documenting program logic in general. It's hard and it's tedious. A design document belongs in the source code. It's not enough if there's a dead tree version filed away on someone's desk. It has to be right there, with the source code. Very few large projects have good design docs because programmers hate writing documentation. They try to get away with arguments like yours, which is ok for the person who wrote the program, but extremely painful for the people who show up later.

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others lurking in the Monastery: (2)
As of 2024-04-20 15:59 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found