home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1992 #31 / NN_1992_31.iso / spool / alt / usage / english / 10106 < prev    next >
Encoding:
Text File  |  1992-12-29  |  2.8 KB  |  60 lines
  1. Newsgroups: alt.usage.english
  2. Path: sparky!uunet!spool.mu.edu!umn.edu!charlie
  3. From: charlie@umnstat.stat.umn.edu (Charles Geyer)
  4. Subject: Re: Comments in source code
  5. Message-ID: <1992Dec29.191042.13088@news2.cis.umn.edu>
  6. Sender: news@news2.cis.umn.edu (Usenet News Administration)
  7. Nntp-Posting-Host: isles.stat.umn.edu
  8. Organization: School of Statistics, University of Minnesota
  9. References: <1992Dec29.060209.17732@g2syd.genasys.com.au>
  10. Date: Tue, 29 Dec 1992 19:10:42 GMT
  11. Lines: 47
  12.  
  13. In article <1992Dec29.060209.17732@g2syd.genasys.com.au>
  14. roberts@g2syd.genasys.com.au (Robert Swan) writes:
  15.  
  16. >I have noticed two principal commenting styles in code (C and FORTRAN)
  17. >that passes across my screen (when there are any comments to observe).
  18. >
  19. >The first is to be found in older code (yep, the FORTRAN) and is
  20. >very impersonal.  It simply states in terse, not quite English, the
  21. >intent of some ensuing piece of gibberish `PROMPT FOR FILENAME', or
  22. >`CHECK RIGHT TYPE'.
  23. >
  24. >However, in the newer code, comments tend to be complete sentences and
  25. >(here's the part that interests me) speak in terms of the 1st person
  26. >plural ...  `We need to get the filename', `We can't proceed unless it's
  27. >the right type'.  Reading the source code has taken on an us and them
  28. >aspect.  I used to catch myself writing comments like this, and change
  29. >it back to a more impersonal form.  Nowadays I don't bother, and quite
  30. >like the idiom.
  31. >
  32. >Who are `we'.  Me and my program?  Me and the other programmers?
  33. >The royal we (since I am creator of the universe in my program,
  34. >I suppose I could put on royal airs)?
  35.  
  36. I venture a guess that it's the influence of hackish.  From the Jargon File
  37.  
  38.    Semantically, one rich source of jargon constructions is the hackish
  39.    tendency to anthropomorphize hardware and software.  This isn't done in
  40.    a na"ive way; hackers don't personalize their stuff in the sense of
  41.    feeling empathy with it, nor do they mystically believe that the things
  42.    they work on every day are `alive'.  What *is* common is to hear
  43.    hardware or software talked about as though it has homunculi talking to
  44.    each other inside it, with intentions and desires.  Thus, one hears "The
  45.    protocol handler got confused", or that programs "are trying" to do
  46.    things, or one may say of a routine that "its goal in life is to X".
  47.    One even hears explanations like "...  and its poor little brain
  48.    couldn't understand X, and it died."  Sometimes modelling things this
  49.    way actually seems to make them easier to understand, perhaps because
  50.    it's instinctively natural to think of anything with a really complex
  51.    behavioral repertoire as `like a person' rather than `like a thing'.
  52.  
  53. This suggests the "we" is all those little homunculi.
  54.  
  55. -- 
  56. Charles Geyer
  57. School of Statistics
  58. University of Minnesota
  59. charlie@umnstat.stat.umn.edu
  60.