如何记录最后合同（通过 jaxb schemagen）网络服务？答案

【问题标题】：How to document contract-last (via jaxb schemagen) webservice?如何记录最后合同（通过 jaxb schemagen）网络服务？
【发布时间】：2012-06-20 20:27:52
【问题描述】：

我开发了一个网络服务，我的用户当然希望看到文档。我更喜欢简单地记录我的代码，无论是使用 javadoc cmets 还是使用显式注释，例如

@XmlComment("This is used to [blah blah]")
@XmlElement(name = "referenceDate", namespace = NAMESPACE, type = Date.class)
public void setReferenceDate(Date referenceDate) {
    this.referenceDate = referenceDate;
}

或

/**
 * This is used to [blah blah]
 */
@XmlElement(name = "referenceDate", namespace = NAMESPACE, type = Date.class)
public void setReferenceDate(Date referenceDate) {
    this.referenceDate = referenceDate;
}

不支持上述内容，如下所示：

JAXB-273 - 2006 年请求从注释中生成 xs:documentation 元素
JAXB-369 - 2007 年请求从 cmets 制作 xs:documentation 元素
SO-470001 - “你不能那样做”stackoverflow 问题

所以我知道我不能使用上述内容来评论我的服务。但是......当然还有一种方法可以以非手动方式进行。我必须为此手工制作所有的 XML 吗？如果 that 是答案，为什么没有更多地关注将这个特性引入 JAXB 呢？对于企业级 Web 服务来说，这似乎完全是强制性的，对吧？

【问题讨论】：

标签： java web-services jakarta-ee jaxb schemagen

【解决方案1】：

你说得对，它很穷。这些天最关注的是合同优先，所以我想它没有被优先考虑。您可以使用 XSLT 从单独的 XML 文档将 cmets 添加到 WSDL。不如从 Java 代码生成它，但总比没有好。这是一个古老的帖子http://www.gridlab.org/WorkPackages/wp-5/guide/wsdltips.html

【讨论】：