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.
I am now at a genuinely neat startup. My main task right now is to
write the JavaDoc comments in their API.
Now, they already have the standard JavaDoc kind of comments (such as
for createUser: /** Creates a new user. @param uName User Name,
etc.*/). I want to make the JavaDoc truly useful for a developer
faced with this API for the first time. Can any of you give some
advice about the types of information that I can include here? Have
you seen (or written) some examples of some exemplary JavaDoc?
A little more info: the first series of APIs that need documenting
are a set of interfaces and a factory class that provide a facade for
a bunch of entity bean classes. The whole thing applies to managing
an app server. Only the interface classes and the one factory class
are going to be visible to the customer.
Any help, pointers, examples, and not-too-derisive comments are
welcome.
Thanks,
Kevin Cheek
cheek1 -at- sbcglobal -dot- net
PS. Please, no debates about JavaDoc versus real programmer's guides
and references. The task has been assigned.
