Documenting your code is not important. Well-documented code is not a thing to be desired nor a goal to be sought. A lack of documentation is not a problem to be solved. Everyone who tells you otherwise is lying.
What is important is that other programmers can easily understand your code and the intent behind it, and that you can understand the code and the intent six months later.
Documenting your code is merely a way of achieving that. It might even be necessary for it. But do not confuse interface with implementation and do not confuse what you want with how to get it.
Solve the problem of confusing, opaque code. Aim for code that can be easily understood. Document if necessary.
(it's pretty much always necessary)
Hacking, Software Collaboration, Testing and Diverse Other Topics of General Interest to the Practicing Programmer
Sunday, July 4, 2010
Subscribe to:
Post Comments (Atom)
Blog Archive
-
▼
2010
(68)
-
►
November
(14)
- testtools manuals
- Tests that print stuff
- Boiling kettles, unit tests and data
- Big or small?
- "Don't Make Me Think", thoughts for Launchpad
- Reviewing specs, rock on!
- Having an extra feature never hurts, rebutted
- And then what?
- Make it really easy to fix bugs on Ubuntu
- What else have you got?
- Ubuntu in a VM on OS X?
- Still going
- What to do, what to do
- Launchpad and UDS-N
-
►
November
(14)

1 comments:
So, document your code. ;-)
Post a Comment