14

我正在寻找为自定义 JSF 2 复合组件库生成文档。复合组件没有在任何 faces-config.xml 文件中引用，而是复合组件的 .xhtml 文件存储在 META-INF/resources 中，并使用新的复合：接口标签来定义接口。

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

4

2 回答 2

2

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

假设您的复合组件位于/META-INF/resources/myLib文件夹中。然后，您需要在文件夹中添加一个myLib.taglib.xml-file，META-INF如下所示：

<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可以轻松地将其集成到您的构建中。基本上只需将其添加到<reporting>您的- 部分pom.xml：

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

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

于 2016-03-15T09:11:59.577 回答
0

rich-faces 组件开发包提供文档注释 http://community.jboss.org/wiki/RichFacesCDKannotations

--kiran.kumar

于 2011-02-24T16:00:09.980 回答