Path: utzoo!utgpu!jarvis.csri.toronto.edu!rutgers!apple!sun-barr!cs.utexas.edu!csd4.milw.wisc.edu!lll-winken!uunet!mitel!sce!cassel
From: cassel@sce.carleton.ca (Ron Casselman)
Newsgroups: comp.sw.components
Subject: Re: Documentation standards for objects?
Keywords: documentation standards
Message-ID: <619@sce.carleton.ca>
Date: 5 Jun 89 18:11:01 GMT
References: <23@dons3b1.UUCP>
Reply-To: cassel@sce.UUCP (Ron Casselman)
Organization: Systems Eng., Carleton Univ., Ottawa, Canada
Lines: 25

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