in reply to Re: Documenting Methods/Subs
in thread Documenting Methods/Subs
There is no such thing as too much documentation, no matter how redundant it may be. Lack of documentation is almost always wrong (programmers should not resort to sourcediving to learn function names).
Lack of needed documentation is always wrong - however over documentation, in my experience, can cause problems. For example:
Personally, I tend to go for development environment with common code ownership and require unit tests for everything. I find this removes most of the need for comments and heavy API documentation during development.
If the team discovers a need for documentation during development then we do it. If the team is not in-house then we will also have appropriate levels of design & implementation documentation as a deliverable (and we'll do it properly too :-)
This has worked well for me with smallish projects (about a dozen coders max).
|
---|