This is Pete Melbourne's TypePad Profile.
Join TypePad and start following Pete Melbourne's activity
Pete Melbourne
Recent Activity
Class, variable, function etc. names should be all the documentation you need for a class. The rest of documentation should be in tests written as a specification of the class.
Comments to me basically say I am unable to give this function a name that appropriately describes what it does, so i will document the intricacies for my future self just in case i forget.
Commented Sep 13, 2011 on Code Tells You How, Comments Tell You Why at Coding Horror
Code Tells You How, Comments Tell You Why
In an earlier post on the philosophy of code comments, I noted that the best kind of comments are the ones you don't need. Allow me to clarify that point. You should first strive to make your code as simple as possible to understand without relying on comments as a crutch. Only at the point whe...
Pete Melbourne is now following The Typepad Team
Sep 13, 2011
Subscribe to Pete Melbourne’s Recent Activity
0 Favorites
Around The Web
