[Pharo-project] new template for class empty comments for OB

laurent laffont laurent.laffont at gmail.com
Mon Apr 25 09:54:28 CEST 2011


Why not a "Please comment this class. Look at class XXXX for a good example
of comment". Replace XXX with a class you like.

Laurent

On Sun, Apr 24, 2011 at 7:39 PM, Stéphane Ducasse <stephane.ducasse at inria.fr
> wrote:

> Hi lukas
>
> could you add the following in OB for missing template
>
> http://code.google.com/p/pharo/issues/detail?id=4090
>
> templateOn: aStream
>        aStream nextPutAll: theClass name; nextPutAll: ' has not been
> documented yet. The class comment should describe the purpose of the class,
> its collaborations and its variables. '.
>        aStream nextPutAll: 'We encourage you to fill up the following
> template.'; cr;cr.
>        aStream nextPutAll: 'Class intention';cr ; tab.
>        aStream nextPutAll: 'I''m doing the following ...';cr;cr.
>
>        aStream nextPutAll: 'Class collaborations'; cr;tab.
>        aStream nextPutAll: 'I usually do not work in isolation but with the
> help of ...'; cr ;cr .
>
>        aStream nextPutAll: 'Class main API'; cr; tab.
>        aStream nextPutAll: 'My main public API is ...'.
>
>        aStream nextPutAll: 'My subclasses may want to override such
> specific hooks ...'; cr.
>
>        aStream nextPutAll: 'Implementation notes';cr.
>
>        self templateLabel: 'Instance Variables:' class: theClass variables:
> theClass instVarNames on: aStream.
>        self templateLabel: 'Class Instance Variables:' class: theClass
> class variables: theClass class instVarNames on: aStream
>
> I did the same for the default browser.
>
> Stef
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.gforge.inria.fr/pipermail/pharo-project/attachments/20110425/903850e1/attachment.htm>


More information about the Pharo-project mailing list