如何设置 TLDDoc 来为 JSP TagLib 创建文档？

Question

我工作的一家公司目前在多个项目中拥有多个标签库。我们使用maven和hudson。我的任务是找到一些可以用来为我们的标签库自动生成文档的东西。我找到了 TLDDoc 但我找不到任何解释如何设置它的内容。请注意，我不是 Java 开发人员，而是使用 JSP 和其他技术的 UI 开发人员。任何帮助将不胜感激。

Answer 1

如果你想执行 TLDDoc 作为 Maven 插件，你可以这样做，例如：

        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>exec-maven-plugin</artifactId>
            <executions>
                <execution>
                    <id>generateTldDoc</id>
                    <phase>prepare-package</phase>
                    <goals>
                        <goal>java</goal>
                    </goals>
                    <configuration>
                        <includePluginDependencies>true</includePluginDependencies>
                        <includeProjectDependencies>false</includeProjectDependencies>
                        <mainClass>com.sun.tlddoc.TLDDoc</mainClass>
                        <arguments>                  
                            <argument>-doctitle</argument>
                            <argument>Whatever Taglib</argument>
                            <argument>-windowtitle</argument>
                            <argument>Whatever Taglib</argument>   
                            <argument>-d</argument>
                            <argument>${project.build.directory}/tlddoc</argument>
                            <argument>src/main/resources/META-INF/something.tld</argument>
                            <argument>src/main/resources/META-INF/somethingelse.tld</argument>
                        </arguments>
                    </configuration>
                </execution>
            </executions>
            <dependencies>
                <dependency>
                    <groupId>taglibrarydoc</groupId>
                    <artifactId>tlddoc</artifactId>
                    <version>1.3</version>
                </dependency>
            </dependencies>
        </plugin>

Answer 2

我也有过类似的需求。我所做的是在 maven 文件中使用 Ant 脚本，它会找到我需要的项目下的所有 TLD 定义文件，并循环遍历每个文件并执行某些操作。

我需要 2 个输出。 HTML 和 DITA（技术文档格式，DOCBOOK 的后继者）。

1. 对于每个 TLD，将调用 TLDDoc 并将其保存到相同的输出目录。
2. 额外的脚本执行 XSLT 样式表，将 TLD xml 转换为 DITA。在 DITA 中，我使用“DITA Open Toolkit”输出为 PDF 和另一种类型的 HTML。

使用 Maven，您需要学习一点 ANT 脚本，并知道如何调用 java 类 (TLDDOC) 或 XSLT 引擎。

这真的很酷，而且非常灵活。