[ENH] Re-commenting ProtoObject and Object

C. Gable Watts CGableWatts at Mac.com
Sun Dec 16 06:31:28 UTC 2001


Change Set:		ProtoObject recommenting
Date:			15 December 2001
Author:			Carl Gable Watts (CGableWatts at Mac.com)

Many of the methods in the root objects of our system (ProtoObject and Object) are insufficiently and sometimes incorrectly commented.  This has made them difficult for novice users to understand and use and also led to experienced users using them incorrectly.  These changes upgrade the comments for most of the methods in ProtoObject; in some cases fixing them when they were wrong and in all cases expanding them to more fully explain their purpose and use.  In order to clearly distinguish between the documentation of the interface of an object from the documentation of the implementation, the first comment for each method describes what the MESSAGE does from the message senders point of view (the interface).  A second optional comment may describe what the METHOD does from the method implementors point of view (the implementation).

None of these changes affect the implementation of these methods, just the comments associated with the methods.

Soon another set of changes will be submitted which similarly upgrades the comments for Object.  My intention is to upgrade the comments for several of the root classes in our system.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: ProtoObject_recommenting.cs
Type: application/octet-stream
Size: 12009 bytes
Desc: not available
Url : http://lists.squeakfoundation.org/pipermail/squeak-dev/attachments/20011215/26fc51cb/ProtoObject_recommenting.obj
-------------- next part --------------
-- 

--------------
C. Gable Watts
Web Page: http://members.Shaw.ca/Gable
ICQ: 5367367
Email: CGableWatts at Mac.com


More information about the Squeak-dev mailing list