[Pharo-project] What is a well documented class?

Stéphane Ducasse stephane.ducasse at inria.fr
Sun Apr 24 17:44:32 CEST 2011


>>> 
>> 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.

yes but.... let us write more comments.
All the rest is arguments not to write them which is far easier as usual.

Stef



More information about the Pharo-project mailing list