Documentation standards for objects?

Article View: comp.sw.components

Article #463

Back to comp.sw.components Previous Next

#463

From: Don Joslyn
Date: Sun, 04 Jun 1989 04:03

20 lines
1254 bytes

Hi,

          I'm  a  "C"  programmer  who  is  now  considering  using   an
     Object-Oriented  programming  language.    Since  a  "function"  is
     different than  an "object",  then maybe  the documentation  should
     also be  different.   I've  seen many  standards proposed  for  the
     documentation of functions,  and I  am now  interrested in  finding
     ideas for documentation of objects.  What additional  documentation
     is required  for an  object?   Do you  know of  a standard,  use  a
     standard, or have ideas or  pointers to articles for  documentation
     of objects?

          I would be grateful for  any suggestions on the  documentation
     of objects.  Thanks in advance for your feedback.

--
Don Joslyn
Cooper City, Florida
UUCP:  ...{gatech!uflorida,ucf-cs}!novavax!dons3b1!don

Technical Details

Message-ID: <23@dons3b1.UUCP>

Path:

arc1-ca.pugleaf.net!utzoo!utgpu!jarvis.csri.toronto.edu!rutgers!tut.cis.ohio-state.edu!ucbvax!pasteur!ames!rex!uflorida!novavax!dons3b1!don

Show Full Headers

Complete Article Headers

Path: arc1-ca.pugleaf.net!utzoo!utgpu!jarvis.csri.toronto.edu!rutgers!tut.cis.ohio-state.edu!ucbvax!pasteur!ames!rex!uflorida!novavax!dons3b1!don
From: don@dons3b1.UUCP (Don Joslyn)
Newsgroups: comp.sw.components
Subject: Documentation standards for objects?
Keywords: documentation standards
Message-ID: <23@dons3b1.UUCP>
Date: 4 Jun 89 04:03:04 GMT
Organization: Private System, Fort Lauderdale, Florida
Lines: 19