Tag Library Documentation Generator

相信Jsp的Taglib一定应用的非常广泛，如典型的Web框架：Struts、WebWork2、Spring等都有自己的Taglib，更不要说JSTL啦。在我们的实际项目开发中，我们也会编写一些项目级别的Taglib，来加快我们的页面开发。Taglib的描述文件（TLD）是一个XML文件，易于数据处理，但是不便于阅读，所以一般的框架都会包含Taglib的详细说明文档，如Struts和WebWork2的Taglib说明文档都非常不错。如果是我们自己编写的Taglib，那么文档可能就没有这么全，这么规范啦，大家在使用Taglib很可能得去查看TLD文件，当然如果你使用某些IDE工具，那么它会自动提示Taglib，也可以为你节省不少时间。
能否依据TLD文件生成一个标准的文档呢，这样大家参考就有了依据，当前已经有不少这样的类似工具：如StrutsDoc可以依据struts-config.xml生成文档、BeanDoc可以根据Spring的配置文件生成文档等等。这里就有一款工具：TLDDoc，它可以将TLD文件转换为类似与JavaDoc风格的文档，如下图就是JSTL的TLD文档：

有了这个工具你就可以快速生成非常标准且实用的TLD说明文档。

TLDDoc的使用非常简单，首先我们从TLDDoc的主页（https://taglibrarydoc.dev.java.net/）下载工具包，下载完毕后进行解压。只需找到相关的tld文件，然后执行以下命名即可：


>java –jar tlddoc.jar –d <outdir> tldfile1.tld tldfile2.tld

如果你想查看详细的帮助信息，可以使用以下命令：


>java –jar tlddoc.jar -help

当前TLDDoc可以处理tld文件、jar文件、war文件及tag files，遵循JSP1.1，1.2和2.0规范，详细的信息参考TLDDoc的帮助信息。

在实际的开发过程中，大家可能更多地使用Ant，这里可以将TLDDoc的命令和Ant结合起来，代码如下：


<java jar="${project.classpath}/tlddoc.jar"
failonerror="true">
<arg line="-d ${project.doc}/taglib"/>
<arg value="WEB-INF/my1.tld"/>
<arg value="WEB-INF/my2.tld"/>
</java>

如果你在实际的开发中结合XDoclet来开发Taglib，这样tld文件生成、tld文档生成在一个Ant的target中就可以快速完成。

总结：TLDDoc对于tld文件的文档处理非常实用，文档规范便于理解。对最新的Jsp 2.0的tag file也能处理，在日常的开发中，完全可以将Taglib的文档交给其去处理，开发出来的Taglib一定会更加专业。

点击此处下载。