Quel outil pour la doc ? [JSP Custom Tags] - Java - Programmation
Marsh Posté le 28-08-2002 à 12:50:58
ben pq pas la javadoc?
Marsh Posté le 28-08-2002 à 15:04:04
--greg-- a écrit a écrit : ben pq pas la javadoc? |
Parce que le resultat est bof... Disons pour etre plus exact que la documentation que je desire obtenir doit plutot etre le reflet de la TLD. Voila. Si quelqu'un a une idee...
Marsh Posté le 28-08-2002 à 15:06:54
exo_ a écrit a écrit : Parce que le resultat est bof... Disons pour etre plus exact que la documentation que je desire obtenir doit plutot etre le reflet de la TLD. Voila. Si quelqu'un a une idee... |
ben rien ne t'empeche d'écrire la doc des attributs dans la javadoc...
c'est le "style" javadoc que t'aimes pas, parce que c'est pas très lisible pour qqun qui connait pas, peut etre?
Marsh Posté le 28-08-2002 à 15:34:32
--greg-- a écrit a écrit : ben rien ne t'empeche d'écrire la doc des attributs dans la javadoc... c'est le "style" javadoc que t'aimes pas, parce que c'est pas très lisible pour qqun qui connait pas, peut etre? |
Hmm disons que pour la personne qui utilise la librairie, c'est effectivement interessant de voir les attributs qui correspondent a des parametres du tag. Sauf que avec "javadoc -private", il a aussi des informations sur des attributs qui ne le concernent absolument pas.
Marsh Posté le 28-08-2002 à 15:36:10
exo_ a écrit a écrit : Hmm disons que pour la personne qui utilise la librairie, c'est effectivement interessant de voir les attributs qui correspondent a des parametres du tag. Sauf que avec "javadoc -private", il a aussi des informations sur des attributs qui ne le concernent absolument pas. |
ben tu lui generes pas le -private tiens.
ou sinon, un traitement de texte, c pas mal aussi
Marsh Posté le 28-08-2002 à 15:42:13
--greg-- a écrit a écrit : ben tu lui generes pas le -private tiens. ou sinon, un traitement de texte, c pas mal aussi |
Bah l'usage veut que les attributs qui correspondent a des parametres soient private, non ? Et sinon le traitement de texte, bah birk ! Quoiqu'il en soit, merci.
Marsh Posté le 28-08-2002 à 15:45:22
exo_ a écrit a écrit : Bah l'usage veut que les attributs qui correspondent a des parametres soient private, non ? Et sinon le traitement de texte, bah birk ! Quoiqu'il en soit, merci. |
ben oui mais je te dis pas de commenter les attributs de classe, mais les attributs du tag, c-a-d dans la doc de la classes du genre
|
genre ça quoi...
Marsh Posté le 28-08-2002 à 15:46:44
exo_ a écrit a écrit : Bah l'usage veut que les attributs qui correspondent a des parametres soient private, non ? Et sinon le traitement de texte, bah birk ! Quoiqu'il en soit, merci. |
Oui, et t'as les setters (et eventuellement les getters, mais y'en a pas trop besoin la) en public. En fait faudrait parser le .tld et génerer la doc a partir de la. Ca doit sans doute exister mais je connais pas.
Marsh Posté le 28-08-2002 à 15:49:40
lorill a écrit a écrit : Oui, et t'as les setters (et eventuellement les getters, mais y'en a pas trop besoin la) en public. En fait faudrait parser le .tld et génerer la doc a partir de la. Ca doit sans doute exister mais je connais pas. |
Voila. C'est exactement ce que je voulais entendre modulo la derniere phrase.
Marsh Posté le 28-08-2002 à 15:50:50
bah tu dois quand meme décrire les attributs du tag quelquepart, de toutes façons, ça se fait pas dans le tld.
Marsh Posté le 28-08-2002 à 15:51:53
--greg-- a écrit a écrit : ben oui mais je te dis pas de commenter les attributs de classe, mais les attributs du tag, c-a-d dans la doc de la classes du genre
|
C'est en partie ce que je fais mais c'est tres laid.
Marsh Posté le 28-08-2002 à 15:53:51
--greg-- a écrit a écrit : bah tu dois quand meme décrire les attributs du tag quelquepart, de toutes façons, ça se fait pas dans le tld. |
NetBeans permet de le faire, faut que je regarde ou il stocke ces infos.
Marsh Posté le 28-08-2002 à 15:55:04
lorill a écrit a écrit : NetBeans permet de le faire, faut que je regarde ou il stocke ces infos. |
oui, et comment il genere la doc...
Marsh Posté le 28-08-2002 à 15:55:35
exo_ a écrit a écrit : C'est en partie ce que je fais mais c'est tres laid. |
ne tiens qu'a toi de changer le stylesheet et le doclet utilisé par javadoc pour generer la doc...
Marsh Posté le 28-08-2002 à 15:56:31
--greg-- a écrit a écrit : bah tu dois quand meme décrire les attributs du tag quelquepart, de toutes façons, ça se fait pas dans le tld. |
Effectivement. D'ailleurs, je n'ai jamais compris pourquoi dans la DTD, ce n'est pas :
<!ELEMENT attribute (name, required? , rtexprvalue?, info?)>
Marsh Posté le 28-08-2002 à 15:57:12
Bon, en fait y'a moyen de mettre une description du tag et un exemple, mais pas directement au niveau attribut.
Marsh Posté le 28-08-2002 à 15:58:09
--greg-- a écrit a écrit : ne tiens qu'a toi de changer le stylesheet et le doclet utilisé par javadoc pour generer la doc... |
A l'instar de tous les bons informaticiens, je suis un gros faineant
Marsh Posté le 28-08-2002 à 16:00:08
exo_ a écrit a écrit : Effectivement. D'ailleurs, je n'ai jamais compris pourquoi dans la DTD, ce n'est pas : <!ELEMENT attribute (name, required? , rtexprvalue?, info?)> |
bah euh parce que c'est pas prévu comme ça
c'est vrai que ça pourrait je crois, mais le tld est là pour informer ton jsp container, pas pour autre chose à priori, mais bon pourrait dire la meme chose des sources java alors.mmmh.
Marsh Posté le 28-08-2002 à 16:01:04
lorill a écrit a écrit : Bon, en fait y'a moyen de mettre une description du tag et un exemple, mais pas directement au niveau attribut. |
bah ouais, en commentaires <!-- truc --> ? pour faire ça, jprefere franchement le foutre en javadoc, perso. à moins qu'il y ait un standard pour documenter ça.
Marsh Posté le 28-08-2002 à 16:01:34
Ce que tu peux toujours faire c'est mettre un commentaire en premier fils de l'element xml, le parseur te permet de le recuperer. Mais bon, ca reste pas terrible.
Marsh Posté le 28-08-2002 à 16:04:00
nan mais en fait, au niveau du tag, dans la tld, y'a un element "<description>", nan? bon ben tu met tout la dedans, c cool.
(j'avais oublié ça...)
Marsh Posté le 28-08-2002 à 22:39:10
--greg-- a écrit a écrit : nan mais en fait, au niveau du tag, dans la tld, y'a un element "<description>", nan? bon ben tu met tout la dedans, c cool. (j'avais oublié ça...) |
Bah oui mais pourquoi ils n'ont pas mis un champ du meme style pour les attributs ? De toute façon, je ne sais toujours pas si il existe un outil pour generer de la doc a partir de la TLD...
Marsh Posté le 29-08-2002 à 00:20:36
exo_ a écrit a écrit : Bah oui mais pourquoi ils n'ont pas mis un champ du meme style pour les attributs ? De toute façon, je ne sais toujours pas si il existe un outil pour generer de la doc a partir de la TLD... |
ben t'as quand meme pas TANT QUE CA à documenter pour chaque attribut. tu met tout au niveau du tag, et basta.
Marsh Posté le 29-08-2002 à 10:06:25
Vous avez trouvé un truc pour génerer une doc a partir des description & exemple du tld finalement ? Parce que j'en ai besoin tout d'un coup et j'ai pas envie de me faire ma propre moulinette
Marsh Posté le 29-08-2002 à 10:16:03
bon, ben visiblement y'a ca :
http://sourceforge.net/forum/forum.php?forum_id=191075
Marsh Posté le 29-08-2002 à 11:06:05
lorill a écrit a écrit : Vous avez trouvé un truc pour génerer une doc a partir des description & exemple du tld finalement ? Parce que j'en ai besoin tout d'un coup et j'ai pas envie de me faire ma propre moulinette |
ben t'avais pas dit que netbeans....?
Marsh Posté le 29-08-2002 à 11:08:40
ben il me permet de la saisir ou de l'ouvrir dans une petite fenetre, mais tout le monde n'utilise pas netbeans et je voudrais bien avoir un export html propre de ce que j'ai tapé dans ma petite fenetre.
Marsh Posté le 29-08-2002 à 11:11:07
lorill a écrit a écrit : ben il me permet de la saisir ou de l'ouvrir dans une petite fenetre, mais tout le monde n'utilise pas netbeans et je voudrais bien avoir un export html propre de ce que j'ai tapé dans ma petite fenetre. |
ha ok
Marsh Posté le 28-08-2002 à 09:26:27
Une sorte d'equivalent de javadoc mais pour les classes des tags...
Quelqu'un a une idee ? Merci d'avance.