用于jsp页面的Doxygen？

Question

我需要在java + jsp（1.0 ...不要让我开始）中记录一个（相当）很大的项目。

对于中间层（所有.java类），我只是使用doxygen来生成.html和.pdf文档，但是我的负责人要求我记录和集成.jsp页面的文档。

AFAIK不是doxygen和javadoc直接适合这份工作。我错了吗？

我能想到的唯一办法是在JSP页面中插入<%/** javadoc-style comments */%>，然后编译的.jsp在.java文件，然后再应用doxygen的...但它是一个有点过intricated ...

Answer 1

JspDoc已经创建，只是为了

jspDoc能够浏览jsp的集合。原理很相似的JavaDoc，你添加注释部分，每个JSP一样的：

<% /** 
<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> 
*/ 

和你能够浏览这个系列有三个服务： - 目录 - >列表中的所有JSP与评论 - 文件 - >提供的JSP结构的摘要，包括上述文件 - jspskelton：渲染HTML和使嵌入的JSP作为文本

见：http://jspdoc.sourceforge.net/