stepharo wrote > I have no problem with changing it this is just that we should in > general write much better class comments.
This is true for all commentary. :-) One of the most important things to include in comments and which is usually omitted is the rationale. Explain why the class exists (it may be obvious in many cases; but usually not so obvious to an outsider), when and why you would use the class. And of course, this doesn't mean we should ignore how to use it. > Stef > > Le 29/4/15 15:17, Sean P. DeNigris a écrit : >> The class comment template begins: "For the Class part: State the name >> of >> the class with one line description: For example, I'm xxx the root of the >> hierarchy of visitor objects." >> >> Unlike a traditional CRC card, we are already in a live programming >> environment with good tools! So the class name is duplicated info (the >> browser already shows this) which will have to be manually changed on a >> class rename. Also, the specific example provides an implementation >> detail >> duplicated by the class hierarchy tree already shown in the browser. I'd >> like to change it to: "For the Class part: State a one line summary. For >> example, "I represent a paragraph of text."" >> >> Any objections? >> >> >> >> ----- >> Cheers, >> Sean >> -- >> View this message in context: >> http://forum.world.st/Class-Comment-Template-Suggestion-tp4822890.html >> Sent from the Pharo Smalltalk Developers mailing list archive at >> Nabble.com. >> >> -- View this message in context: http://forum.world.st/Class-Comment-Template-Suggestion-tp4822890p4824840.html Sent from the Pharo Smalltalk Developers mailing list archive at Nabble.com.
