[squeak-dev] New default comment template from WACallback

gettimothy gettimothy at zoho.com
Thu Feb 10 11:52:51 UTC 2022


Hi Folks,



I am doing a deep dive into the Seaside framework and I saw this neat comment template in the WACallback comment:





Class: WACallback
                                                                                                    





Please comment me using the following template inspired by Class Responsibility Collaborator (CRC) design:





For the Class part:  State a one line summary. For example, "I represent a paragraph of text".







For the Responsibility part: Three sentences about my main responsibilities - what I do, what I know.





For the Collaborators Part: State my main collaborators and one line about how I interact with them.







Public API and Key Messages


•	message one


•	message two


•	(for bonus points) how to create instances.





One simple example is simply gorgeous.





Internal Representation and Key Implementation Points.





Instance Variables
key:  <Object>





Implementation Points




Thought you all might be interested.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.squeakfoundation.org/pipermail/squeak-dev/attachments/20220210/fb5cb58f/attachment.html>


More information about the Squeak-dev mailing list