home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1992 #31 / NN_1992_31.iso / spool / alt / usage / english / 10087 < prev    next >
Encoding:
Text File  |  1992-12-29  |  1.5 KB  |  39 lines
  1. Newsgroups: alt.usage.english
  2. Path: sparky!uunet!munnari.oz.au!yarrina.connect.com.au!warrane.connect.com.au!g2syd!roberts
  3. From: roberts@g2syd.genasys.com.au (Robert Swan)
  4. Subject: Comments in source code
  5. Message-ID: <1992Dec29.060209.17732@g2syd.genasys.com.au>
  6. Organization: Genasys II, Sydney, Australia
  7. Date: Tue, 29 Dec 1992 06:02:09 GMT
  8. Lines: 29
  9.  
  10. I have noticed two principal commenting styles in code (C and FORTRAN)
  11. that passes across my screen (when there are any comments to observe).
  12.  
  13. The first is to be found in older code (yep, the FORTRAN) and is
  14. very impersonal.  It simply states in terse, not quite English, the
  15. intent of some ensuing piece of gibberish `PROMPT FOR FILENAME', or
  16. `CHECK RIGHT TYPE'.
  17.  
  18. However, in the newer code, comments tend to be complete sentences and
  19. (here's the part that interests me) speak in terms of the 1st person
  20. plural ...  `We need to get the filename', `We can't proceed unless it's
  21. the right type'.  Reading the source code has taken on an us and them
  22. aspect.  I used to catch myself writing comments like this, and change
  23. it back to a more impersonal form.  Nowadays I don't bother, and quite
  24. like the idiom.
  25.  
  26. Who are `we'.  Me and my program?  Me and the other programmers?
  27. The royal we (since I am creator of the universe in my program,
  28. I suppose I could put on royal airs)?
  29.  
  30. Has anyone else noticed anything similar?  Or am I just losing my
  31. marbles?
  32.  
  33. Have fun,
  34.  
  35. Robert.
  36. -- 
  37. I used to be indecisive,   | Robert Swan, roberts@g2syd.genasys.com.au
  38. but now I'm not so sure.   | Genasys II Pty. Ltd., North Sydney.
  39.