home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1992 #26 / NN_1992_26.iso / spool / comp / lang / cplus / 16104 < prev    next >
Encoding:
Text File  |  1992-11-11  |  1.9 KB  |  42 lines
  1. Newsgroups: comp.lang.c++
  2. Path: sparky!uunet!utcsri!torn!nott!bnrgate!bcrka451!bcrki65!sjm
  3. From: sjm@bcrki65.bnr.ca (Stuart MacMartin)
  4. Subject: Re: Criticisms Wanted
  5. Message-ID: <1992Nov11.175117.15325@bcrka451.bnr.ca>
  6. Sender: 5E00 Corkstown News Server
  7. Organization: Bell-Northern Research Ltd., Ottawa, Canada
  8. References: <1992Nov8.170309.12301@cc.gatech.edu> <BxGu0p.D3o@slipknot.rain.com> <1992Nov11.170816.24497@cc.gatech.edu>
  9. Date: Wed, 11 Nov 1992 17:51:17 GMT
  10. Lines: 30
  11.  
  12. In article <1992Nov11.170816.24497@cc.gatech.edu> brianm@cc.gatech.edu (Brian N. Miller) writes:
  13. >In article <BxGu0p.D3o@slipknot.rain.com> robert@slipknot.rain.com.UUCP (Robert Reed) writes:
  14. >>
  15. >>The argument goes that if you
  16. >>still have to examine the internal workings of component classes to determine
  17. >>how to best use them, then their value as components has been greatly
  18. >>diminished.
  19. >
  20. >Ok.  So anybody have any ideas?
  21.  
  22. Documentation, anyone?
  23. Obviously the C++ syntax for the class interface does not tell me anything about
  24. how to use the class correctly for a given situation.  If I am a provider of a class,
  25. surely it is my responsibility to identify the needs of my clients (the users of 
  26. the class) and to give them sufficient information about the class.  
  27.  
  28. The real question is *why* does the user have to look into the inner workings of
  29. the class?  Surely not to discover the inner workings, but to discover behavioural
  30. characteristics of the class.  Will these be clear from looking inside the class?
  31. Does the user enjoy poking his nose around where he doesn't belong?
  32.  
  33. I don't think that C++ is self-documenting code.  Usage notes should be provided
  34. where appropriate.
  35.  
  36. Stuart
  37.  
  38. --
  39. : Stuart MacMartin                                    email: sjm@bnr.ca      :
  40. : Bell-Northern Research                              phone: (613) 763-5625  :
  41. : PO Box 3511, Stn C, Ottawa, K1Y-4H7, CANADA    Standard disclaimers apply. :
  42.