list4xt : Mailing list for the XT users community.
[list4xt] Re: Volunteer : documentation
Subject: [list4xt] Re: Volunteer : documentation
User: Website From: Paul T (pault12345@yahoo.com)
Date: 02/06/2000 - 00:33
Ron,
> Have you some other tool or document system in mind?
XML + XSLT ;-) I mean that grabbing some existing / developing some new DTD / Schema for documenting the java code ( idealy with some gateway to / from javadoc ) could be better on long run ( and looks like a cool project itself ). We may use this mix for 'secondary documentation' , when Javadoc will work for detailes ... I realy don't know ... I have not spend too much time looking for such a DTD. Anybody knows some ?
Rgds.Paul.
PS. Please, don't get me wrong - I have nothing against JavaDoc - maybe I just don't understand how to use it properly to describe the internal dataflows in 'ideal' way. One of the examples of 'view from top' is attempt of Mozilla team to provide the 'roadmap' documents ( I don't think they got a success there, but I think that happened not because they were using wrong structure, but because they have not published realy important documents ;-) I think we agree that are multiple ways of structuring documents. I think JavaDoc structuring is handy for developer when he is 'already familiar with the concepts'. Getting the concepts out of javadoc is harder than it could be. At least I know that it is hard to me - people are different ;-) JavaDoc is good where you are 'already inside the code', but not good for jump-starting - that's what I mean ( and I think Eric says the same thing ).
---------------------------------
Do You Yahoo!?
Send instant messages & get email alerts with Yahoo! Messenger.
--
Mailing list for the XT users community. (http://bancroftstatebank.com)
(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
|