writing for programmers

Subject: writing for programmers
From: Barbara Hubert <barbara_hubert -at- epicdata -dot- com>
To: tech list <TECHWR-L -at- lists -dot- raycomm -dot- com>
Date: Thu, 13 Apr 2000 10:24:28 -0700

I'd start by learning something about object oriented programming in
Maybe take a course at your local community college.

Addison Wesley has a Java Tutorial that is pretty good. You also might
try Sun
Microsystem's Site as they have an excellent developer's network at
http://www.java.sun.com. You might look there for some decent examples

Javadoc is utility that generates MIF files or HTML files from comments
in the
source code itself. The comments must be written and edited right in the
There is another tool called DocWiz that is suppose to allow you to edit
code while protecting it. Unfortunately, DocWiz doesn't always save and
unreliable. Javadoc looks for packages, classes, constructors, methods,
inheritance, etc., then generates them as sub heads in a preformatted
HTML doc.
If you have commented these features/elements out, Javadoc will generate
text according to a predefined format that is executed using special

You can write package (.pkg) and overview files separately and Javadoc
compile them into the final output, a .chm file.

A functional spec is the first document produced in the product life
cycle and
includes all the business logic, etc., for the product. I'm sure if you
the archives there is a couple of detailed descriptions there.

Finally, yes all those symbols in viso are very meaningful, some
processes, some applications, some server containers....

hope that helps

Previous by Author: Of Mice and Men
Next by Author: to the HTML gurus out there
Previous by Thread: Re: Writing for programmers
Next by Thread: Graphics conflict between Word 2000 and Frame 5.5.6

What this post helpful? Share it with friends and colleagues:

Sponsored Ads