[Pharo-project] comments comments comments again

Dale Henrichs dhenrich at vmware.com
Mon Feb 28 09:36:11 CET 2011


Interestingly enough, I have added a class comment to the metacello configuration template class, but when I copy the class, the class comment is not copied ... everything else makes it ... I had hoped that the comment would be present in the copy ... I suppose I could add the comment programmitcally...


On Feb 28, 2011, at 12:13 AM, Stéphane Ducasse wrote:

>> Hi Stéph,
>>  why not implement a tool that takes a package, asks the user to
>> identify the most important class comment, and the creates comments
>> for all uncommented classes in the package that direct the user to the
>> most important class comment?  The generated comment could use the
>> squeak code hyperlink support so the user just has to double click in
>> the generated comment to get to the new comment.  How about also
>> including in the comment template a suggestion of what kind of
>> entry-point documentation you'd like to see?
> I think that it would give the impression that there are comments.
> Here my point was: "let us think 1 s about what is the key information a user would need?
> oh of course how to execute the configuration so that it loads"
> So this line should not be that difficult to add
> To load me, execute
> 	((Smalltalk globals at: #ConfigurationOfPharo) project version: #stable) load
> Because I'm lost with latest, default, load ....
> We should have tool to use class comments to raise their values.
> I hope soon that we will have a SmalltalkDoc up and running.
> Stef

More information about the Pharo-project mailing list