用於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/