我开发了一个网络服务,我的用户理所当然地希望看到文档。我更喜欢简单地记录我的代码,使用 javadoc 注释或显式注释,例如
@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 请求从评论中制作 xs:documentation 元素
- SO-470001 - “你不能那样做”stackoverflow 问题
所以我知道我不能使用上述内容来评论我的服务。但是......当然还有一种方法可以以非手动方式进行。我必须为此手工制作所有的 XML 吗?如果这就是答案,为什么没有更多地关注将这个特性引入 JAXB 呢?对于企业级 Web 服务来说,这似乎是完全强制性的,对吧?