On 1/14/2011 11:10 AM, Achilleas Margaritis wrote:
The same documentation can be put in the implementation file.
Yes, if you have formal conventions for documentation you can achieve the separation (as is done in well-written Java programs), but it is so much easier to do if you have separate specs, and it solves the problem of multiple implementations with a single specification so much more cleanly.
The Qt source code contains all the documentation in the implementation files (for a good reason: headers are parsed again and again).
Surely you are not claiming that parsing comments in header files takes a significant amount of time, if so, that's a patently incorrect claim, which you cannot back up with quantitative data since it is false (how do I know it is false, we DO have such data for Ada, from early on when we wondered whether to bother with it, and that was with machines of the speed of 20 years ago, and the answer was no then, and is even more definitely no now).
