为JSF 2组合组件生成文档

Question

我希望生成一个自定义JSF 2组合组件库的文档。这些组合组件没有在任何faces-config.xml文件中被引用，而是将组合组件的.xhtml文件存储在META-INF/resources中，并使用新的composite:interface标签来定义接口。

对于JSP标签库，可以使用https://taglibrarydoc.dev.java.net/生成文档，我想知道是否有类似的工具可以用于我的JSF 2组合组件库。

- digitaljoel

---

相关：如何生成Facelets文档？ - BalusC

Answer 1

您可以使用OmniFaces Vdldoc从<cc:interface>标签（或taglib.xml文件中的文档）生成文档。

假设您的组合组件位于/META-INF/resources/myLib文件夹中。那么，您需要在META-INF文件夹中创建一个myLib.taglib.xml文件，内容如下：

<facelet-taglib>
    <description>Your description</description>
    <namespace>http://example.com/myLib</namespace>
    <short-name>my</short-name>
    <composite-library-name>myLib</composite-library-name>
</facelet-taglib>

为了提供更完整的例子，请查看这个问题。

您现在可以使用Vdldoc来生成您的文档：

java -jar vdldoc-2.1.jar myLib.taglib.xml

更新： 如果您的项目使用maven，现在有vdldoc-maven-plugin可以轻松地将其集成到构建中。只需将其添加到pom.xml的<reporting>部分即可：

<reporting>
  <plugins>
    <plugin>
      <groupId>com.github.matinh.vdldoc</groupId>
      <artifactId>vdldoc-maven-plugin</artifactId>
      <version>2.0</version>
    </plugin>
  </plugins>
</reporting>

运行mvn site生成文档。有关更多详细信息，请参见插件主页。

- Martin Höller

Answer 2

RichFaces 组件开发工具包提供了文档注释 http://community.jboss.org/wiki/RichFacesCDKannotations

--kiran.kumar

- kiran.kumar M

---

但这并不适用于JSF 2组合组件。 - digitaljoel