home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1992 #31 / NN_1992_31.iso / spool / alt / usage / english / 10108 < prev    next >
Encoding:
Internet Message Format  |  1992-12-29  |  1.7 KB
  1. Path: sparky!uunet!spool.mu.edu!uwm.edu!zaphod.mps.ohio-state.edu!ub!rutgers!rochester!rit!moscom!jmp
  2. From: jmp@moscom.com (Joe Palumbos)
  3. Newsgroups: alt.usage.english
  4. Subject: Re: Comments in source code
  5. Message-ID: <4815@moscom.com>
  6. Date: 29 Dec 92 18:31:58 GMT
  7. References: <1992Dec29.060209.17732@g2syd.genasys.com.au>
  8. Organization: Moscom Corp., E. Rochester, NY
  9. Lines: 34
  10. X-Newsreader: TIN [version 1.3 beta PL7]
  11.  
  12. Robert Swan (roberts@g2syd.genasys.com.au) wrote:
  13. : 
  14. : [....]
  15. : However, in the newer code, comments tend to be complete sentences and
  16. : (here's the part that interests me) speak in terms of the 1st person
  17. : plural ...  `We need to get the filename', `We can't proceed unless it's
  18. : the right type'.  [....]
  19. : 
  20. : Who are `we'.  Me and my program?  Me and the other programmers?
  21. : The royal we (since I am creator of the universe in my program,
  22. : I suppose I could put on royal airs)?
  23. : 
  24. : Has anyone else noticed anything similar?  Or am I just losing my
  25. : marbles?
  26. : 
  27.  
  28.  
  29. For the last 16 years (i.e. since I've been programming), I've done 
  30. this also, and never stopped to think who I mean by 'we', until now.  
  31.  
  32. In my mind, I am writing the comments for the benefit of either the next 
  33. person to maintain the code, or for myself, after I've forgotten what 
  34. the hell I was doing the first time around.  Even in the latter case, 
  35. I may as well be a different person anyway, since in either case, I 
  36. don't know what the author had in his head at the time he wrote the 
  37. code.
  38.  
  39. Therefore, when I write 'we', I am referring to both of us:  Me, the 
  40. author, and the kind person in the future, looking at my code.
  41.  
  42. -regards, from both of us.
  43.  
  44. -- 
  45. Joe Palumbos    jmp@moscom.com        {rit,tropix,ur-valhalla}!moscom!jmp
  46.