TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: SDK/API documentation From:Chris Hamilton <chamilton__ -at- YAHOO -dot- COM> Date:Thu, 22 Oct 1998 05:24:09 -0700
The purpose of object-oriented design and implementation is *not* to
create self-documenting code. It is to create code that is
encapsulated and resuable. (Encapsulation means that you can use it
like a black box. You plug it in, give it what it needs and it works.)
If documentation weren't required for object-oriented code, Sun would
not have spent time and money developing JavaDoc, which does just
that. It would not have documentation on its classes. And no one would
be buying _Java in a Nutshell_. Every Java developer I know uses that
book.
In short, absent any supporting information from the developer, I
would not agree that no documentation is necessary in this case. But I
would lit him try to convince me.
==
====================
Chris Hamilton
chamilton__ -at- yahoo -dot- com (double underscore)
_________________________________________________________
DO YOU YAHOO!?
Get your free @yahoo.com address at http://mail.yahoo.com
