Class comments!?

Frank Shearar Frank.Shearar at rnid.org.uk
Wed Oct 20 09:24:43 UTC 2004


> Randal L. Schwartz <merlyn at stonehenge.com> wrote:
> 
> And this may just add fuel to the fire, but as an old-time 
> Smalltalker,
> I prefer the first-person-style class comments:
> 
> Rs232Interface class>>[comment]:
> 
>         I am the hardware controller for the RS232 interface.
>         I can enable and disable the device, as well as set and get
>         status information.
>         My instances are usually configured with 
> StreamManagers to provide
>         CR-LF processing and record delivery.
> 
> Like that.  First person, active voice.

I must confess, I found the first person class comments a bit odd at first. But I got used to it, and then started to like it - I like it sufficiently to use it in my Delphi code (my day job) too. And active voice I find infinitely more pleasurable to read than passive voice - "it was discovered that...".

frank


*******************************************************************
This email and any files transmitted with it are confidential
and intended solely for the use of the individual or entity to
whom they are addressed. Any views or opinions expressed
are solely those of the author and do not necessarily represent
RNID policy.
If you are not the intended recipient you are advised that any
use, dissemination, forwarding, printing or copying of this
email is strictly prohibited.
If you have received this email in error please notify the RNID
Helpdesk by telephone on: +44 (0) 207 296 8282.
The Royal National Institute for Deaf People
Registered Office 19*23 Featherstone Street
London EC1Y 8SL No. 454169 (England)
Registered Charity No. 207720
********************************************************************




More information about the Squeak-dev mailing list