Documentation standards for objects?

Thread View: comp.sw.components

3 messages

[T] Back to Threads [V] Tree View [G] Group Articles

3 total messages Started by Don Joslyn Sun, 04 Jun 1989 04:03

#463

Author: 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

Re: Documentation standards for objects?

#467

Author: Ron Casselman
Date: Mon, 05 Jun 1989 18:11

25 lines
1405 bytes

In article <23@dons3b1.UUCP> don@dons3b1.UUCP (Don Joslyn) writes:
>
>          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

Try "Object Oriented Programming An Evolutionary Approach" by Brad J. Cox.
The author draws an analogy between hardware specification sheets
and documentation sheets for objects. Object documentation should
be precise and concise so that experienced programmers can find
information quickly. The author suggests an object documentation
layout and uses it to document the object classes provided with the
Objective C compiler from StepStone Corporation.

I find inheritance graphs invaluable aids as well.

Ron Casselman
Systems Engineering,
Carleton University
Ottawa Canada

Re: Documentation standards for objects?

#470

Author: Jim Adcock
Date: Fri, 09 Jun 1989 18:24

2 lines
481 bytes

Try writing a un*x manual page for it.  If that doesn't seem to fit
the bill, its probably not an object.

Thread Navigation

This is a paginated view of messages in the thread with full content displayed inline.

Messages are displayed in chronological order, with the original post highlighted in green.

Use pagination controls to navigate through all messages in large threads.

Back to All Threads