Doxygen pour pages jsp?

Question

J'ai besoin de documenter un (assez) grand projet en java + jsp (1.0 ... ne me fais pas démarrer).

Pour le niveau intermédiaire (toutes les classes .java), j'ai simplement utilisé doxygen pour générer des documents .html et .pdf, mais mon chef m'a demandé de documenter et d'intégrer la documentation des pages .jsp.

AFAIK pas doxygen ni javadoc ne sont directement adaptés pour ce travail. Ai-je tort?

La seule façon que je peux penser est d'insérer <%/** javadoc-style comments */%> dans les pages jsp, puis compiler le .jsp dans .java fichiers, puis appliquez doxygen ... mais il est un peu trop intriqués ...

Answer 1

JspDoc a été créé juste pour cela

jspDoc est capable de parcourir une collection de jsp. Le principe est très similaire à JavaDoc, vous ajoutez une section de commentaire à chacun de vos jsp comme:

<% /** 
<doc> 
<name>directory2.jsp</name> 
<category>System</category> 
<summary>List all jsp files with category and summary</summary> 
<history><date>10/08/01 us</date> Gilbert Brault 
<action> creation</action> 
</history> 
<history><date>10/25/01 us</date> Gilbert Brault 
<action> adapted pharos:foreach switch itCounter to Integer (was int before)</action> 
</history> 
<outline> 
<ul> 
<li>if refresh set or new session, list all jsp files of the server and parse them</li> 
<li>List files according to the following criteria 
<ul> 
<li>creation order (item #) column</li> 
<li>file name (no case sensitive)</li> 
<li>category of processing</li> 
</ul> 
</li> 
</ul> 
</outline> 
<todo> 
<ul> 
<li>display modification date and allow ordering by dates</li> 
</ul> 
</todo> 
<copyright>Schneider-Electric 2001</copyright> 
</doc> 
*/ 

et vous êtes en mesure de parcourir cette collection avec trois services: - annuaire -> Afficher tous les jsp avec des commentaires - Document -> fournir un résumé de la structure de jsp, y compris la documentation ci-dessus - jspskelton: rendre le code html et embedd le jsp sous forme de texte

voir: http://jspdoc.sourceforge.net/