3 ms·
First of all, to begin with a famous quote: Documentation "…when it is good, it is very, very good; and when it is bad, it is better than nothing." - Dick Bran
by chacham15 13y ago
First of all, to begin with a famous quote:
Documentation "…when it is good, it is very, very good; and when it is bad, it is better than nothing."
- Dick Brandon
Second of all, I couldnt disagree more with this statement for certain types of projects:
"If you included all of the things needed to document a project in source, your code would be unreadable."
I believe in self documenting code with additional information for API functions. A really good way of doing this is with wonderful tools like Doxygen: http://www.stack.nl/~dimitri/doxygen/ http://www.stack.nl/~dimitri/doxygen/