Issue 4090 in pharo: Better default template for absent class comment

Status: FixToInclude
Owner: [hidden email]
CC: renggli
Labels: Type-OB

New issue 4090 by [hidden email]: Better default template for absent  
class comment
http://code.google.com/p/pharo/issues/detail?id=4090

ORClassCommentDefinition>>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 will add the same to the default browser.




_______________________________________________
Pharo-bugtracker mailing list
[hidden email]
http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-bugtracker

Comment #1 on issue 4090 by [hidden email]: Better default template  
for absent class comment
http://code.google.com/p/pharo/issues/detail?id=4090

Browser>>noCommentNagString

        ^ Text string: 'Unfortunately this class has not been documented yet. The  
class comment should describe the purpose of the class, its collaborations  
and its variables. We encourage you to fill up the following template.

Class intention
        I m doing the following ...

Class collaborations
        I usually do not work in isolation but with the help of ...

Class main API
        My main public API is ...My subclasses may want to override such specific  
hooks ...
Implementation notes
' translated attribute: TextColor red.
               


_______________________________________________
Pharo-bugtracker mailing list
[hidden email]
http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-bugtracker

Comment #2 on issue 4090 by [hidden email]: Better default template  
for absent class comment
http://code.google.com/p/pharo/issues/detail?id=4090

(No comment was entered for this change.)

Attachments:
        Browser-noCommentNagString.st  718 bytes


_______________________________________________
Pharo-bugtracker mailing list
[hidden email]
http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-bugtracker

Updates:
        Cc: [hidden email]

Comment #3 on issue 4090 by [hidden email]: Better default template  
for absent class comment
http://code.google.com/p/pharo/issues/detail?id=4090

Stef, what is the definition of templateLabel: 'Instance Variables:' class:  
theClass variables: theClass instVarNames on: aStream  please?


_______________________________________________
Pharo-bugtracker mailing list
[hidden email]
http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-bugtracker

Comment #4 on issue 4090 by [hidden email]: Better default template  
for absent class comment
http://code.google.com/p/pharo/issues/detail?id=4090

the one of standard OB so showing instance variable type probably


_______________________________________________
Pharo-bugtracker mailing list
[hidden email]
http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-bugtracker

Comment #5 on issue 4090 by renggli: Better default template for absent  
class comment
http://code.google.com/p/pharo/issues/detail?id=4090

#templateLabel:class:variables:on: is part of the refactoring engine. If  
you don't have therefactoring engine loaded you get the system defined  
template from ClassDescription>>#classCommentBlank.


_______________________________________________
Pharo-bugtracker mailing list
[hidden email]
http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-bugtracker

Updates:
        Status: closed

Comment #6 on issue 4090 by [hidden email]: Better default template  
for absent class comment
http://code.google.com/p/pharo/issues/detail?id=4090

in 13185


_______________________________________________
Pharo-bugtracker mailing list
[hidden email]
http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-bugtracker

Updates:
        Labels: MigratedToFogBugz

Comment #7 on issue 4090 by [hidden email]: Better default template  
for absent class comment
http://code.google.com/p/pharo/issues/detail?id=4090#c7

Issue migrated to https://pharo.fogbugz.com/f/cases/4136

--
You received this message because this project is configured to send all  
issue notifications to this address.
You may adjust your notification preferences at:
https://code.google.com/hosting/settings

_______________________________________________
Pharo-bugtracker mailing list
[hidden email]
http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-bugtracker