Implementation notes iv and their purposes
May I ask, what if we stopped ever mentioning instance vars in the class comment? Perhaps it's a problem of having only one place to document both external and internal details of the class, but it really irks me when the comment template for a newly created class suggests that I divulge the implementation details in what appears to be a document of the interface. Moreover, the comment must change when the implementation changes, even if the interface remains the same. Perhaps that's why so many class comments seem out of sync with the current state of their classes.
Indeed. Synchronizing the documentation and the code is a problem. Alexandre -- _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: Alexandre Bergel http://www.bergel.eu ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.