list4xt : Mailing list for the XT users community.
[list4xt] Re: Volunteer : documentation
Subject: [list4xt] Re: Volunteer : documentation
User: Website From: Dave Pawson (dave.pawson@virgin.net)
Date: 02/06/2000 - 19:16
Ron Ten-Hove
Perhaps my use of the terms "primary" and "secondary" imply too much.
I meant that the largest effort would be to provide the detailed
implementation documentation that is sorely lacking in XT.
I would submit that the goal of the detailed documentation would be
to enhance understandability and thus maintainability.
+1
My proposal to use JavaDoc for the detailed docs is motivated partly
by pragmatism, partly by force of habit, and partly company loyalty
(my company is owned by Sun Microsystems, after all). Have you
some other tool or document system in mind?
How about plain English?
With the given objective, understanding is the key.
James is such a clever fellow, it takes me all my time to understand
his exectutables :-) never mind the code.
I think an overview, perhaps with the 'why I did it that way'
from James jade experience would be a best start, to permit
others to understand it.
Javadoc I only find useful when I want to use and interface.
Am I alone in this?
Regards, DaveP
--
Mailing list for the XT users community. (http://csrclearinghouse.org)
(mailto:list4xt-request@4xt.org?Subject=unsubscribe to unsubscribe)
Archive générée par hypermail 2b28 le 06/11/2001 - 11:46 CET
webmaster@4xt.org
|