从CXF 2.7.5运行wsdl2java
进行类似操作
<xsd:complexType name="baseTaxParametersEnhanced">
<xsd:annotation>
<xsd:documentation>
Some type comment.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="municipality" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Some member comment.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="zip" type="xsd:string" />
为BaseTaxParametersEnhanced
类生成Javadoc,但不为municipality
成员生成Javadoc。
这出乎意料,我没有看到文档中提到的用于打开/关闭此标志的标志?
不幸的是,几乎没有什么可以轻松解决的。 wsdl2java
在后台使用xjc生成类。为此提出了一个旧问题(JAXB-172)。您可以投票。没有xjc插件可以解决此问题。 How to make generated classes contain Javadoc from XML Schema documentation中提到了有关此问题的更多信息。
如此处所述,如果您可以控制WSDL / XSD文件,则可以用嵌入式自定义绑定(jxb:javadoc)替换xsd:documentation。要实现这一点,您应该声明jxb名称空间,例如:
<xsd:schema ... xmlns:jxb="http://java.sun.com/xml/ns/jaxb">
并更改您的类型声明:
<xsd:complexType name="baseTaxParametersEnhanced">
<xsd:annotation>
<xsd:appinfo>
<jxb:class>
<jxb:javadoc>Some type comment.</jxb:javadoc>
</jxb:class>
</xsd:appinfo>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="municipality" type="xsd:string">
<xsd:annotation>
<xsd:appinfo>
<jxb:property>
<jxb:javadoc>Some member comment.</jxb:javadoc>
</jxb:property>
</xsd:appinfo>
</xsd:annotation>
</xsd:element>
<xsd:element name="zip" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
此解决方案的问题在于,其他WSDL / XSD工具将无法识别这些注释。
如果您无法控制WSDL / XSD,则可以使用外部JAXB绑定执行相同的操作,但是似乎开销太大。
如果可以的话,请总结提到的问题。也许有一天,有人认为是时候实施该功能了。
编辑
[我认为一个人不能使用XJC插件执行这样的任务很奇怪(提到的问题中有一个评论说,我决定尝试编写这样的插件。
结果可以在这里找到:https://github.com/destin/xjc-javadoc-plugin
当前,它仅向复杂类型的字段(而不是getter或setter)添加注释。如果有任何改进建议,我将不胜感激。当我认为它足够稳定时,我将尝试将其贡献给CXF项目,以便任何人都可以轻松使用它。
关于xjc-javadoc-plugin。如项目页面上所述:“插件已合并到Apache CXF XJC Utils中”。尽管在https://cxf.apache.org/xjc-utils.html页上没有任何内容。但是在那里。对于使用“来自Apache”的插件:
<plugin>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-codegen-plugin</artifactId>
<version>3.3.5</version>
<executions>
<execution>
<!-- ... -->
<configuration>
<wsdlOptions>
<wsdlOption>
<!-- ... -->
<extraargs>
<extraarg>-xjc-Xjavadoc</extraarg>
</extraargs>
</wsdlOption>
</wsdlOptions>
</configuration>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.apache.cxf.xjcplugins</groupId>
<artifactId>cxf-xjc-javadoc</artifactId>
<version>3.3.1</version>
</dependency>
</dependencies>
</plugin>
或
<plugin>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-xjc-plugin</artifactId>
<version>3.3.1</version>
<configuration>
<extensions>
<extension>org.apache.cxf.xjcplugins:cxf-xjc-javadoc:3.3.1</extension>
</extensions>
</configuration>
<executions>
<execution>
<!-- ... -->
<configuration>
<!-- ... -->
<xsdOptions>
<xsdOption>
<!-- ... -->
<extensionArgs>-Xjavadoc</extensionArgs>
</xsdOption>
</xsdOptions>
</configuration>
</execution>
</executions>
</plugin>