我目前正在使用在大多数类型和元素上具有<xsd:annotation>
/
的XML模式<xsd:documentation>
。当我从此XML模式生成Java
Bean时,这些Bean的Javadoc仅包含一些有关类型/元素的允许内容的通用生成信息。
我想<xsd:documentation>
在相关位置查看标记的内容(例如,complextType的标记的内容应显示在代表该complexType的类的Javadoc中)。
有什么办法可以做到这一点?
编辑 :此XML Schema将在具有JAX-WS的WSDL中使用,因此此标记也可能适用。
编辑2 :我读过有关<jxb:javadoc>
。据我了解,我可以在一个单独的JAXB绑定文件中或直接在XML
Schema中指定它。那几乎可以解决我的问题。但是我宁愿使用现有的<xsd:documentation>
标签,因为Javadoc不是文档的主要目标(它主要是关于数据结构的信息,而不是有关从中生成的Java
Bean的信息),并且允许非JAXB工具以如下方式访问信息:好。同时提供文档<jxb:javadoc>
和xsd:documentation>
“感觉”都是错误的,因为我没有充分的理由来复制数据(和工作)。
编辑3
:感谢Pascal的回答,我意识到我已经有了一半解决方案:<xsd:documentation>
的complexType
s写入其Javadoc的开头!问题仍然是
只有 该complexType
S用于和simpleType
S(这也可导致在一个类)和元素仍然Javadoc的更小。
xsd:documentation
除非 且仅当 它是复杂类型时,我才能永远不能将其放置在java源代码中。元素,简单类型等的文档将被忽略。
因此,我最终使用jxb:javadoc
。为此,请xmlns:jxb="http://java.sun.com/xml/ns/jaxb"
在您的<xsd:schema>
元素中包含的定义。
向<xsd:complexType>
或<xsd: element>
或添加孩子<xsd:attribute>
:
<xsd:annotation><xsd:appinfo><jxb:XXX><jxb:javadoc>
This is my comment for a class/property
</jxb:javadoc></jxb:XXX></xsd:appinfo></xsd:annotation>
其中XXX是“类”或“属性”。
对于包裹,您可以写一个孩子 xsd:schema
<xsd:annotation><xsd:appinfo><jxb:schemaBindings><jxb:package name="com.acme"><jxb:javadoc>
This is my comment for a package
</jxb:javadoc></jxb:package></jxb:schemaBindings></xsd:appinfo></xsd:annotation>
编写HTML文档时需要使用方括号括起来 <![CDATA[ --- ]]>
(编辑:在写我的答案时,问题已由OP进行了编辑,因此我正在相应地对其进行更新)
就我而言,javadoc是唯一的目标,因此可以接受使用jxb:javadoc
。但是您的更新非常合理,实际上,我完全同意您的看法。可悲的是,我从未找到适合您所描述情况的理想解决方案(因此,我将非常仔细地关注这个问题)。也许您可以使用xframe之类的东西来从中生成文档xsd:documentation
,但这不能解决问题。
目前,expertion生成REST API文档,但是响应体不包含关于响应的JSON结构的信息。在我的理解中,如果我包含由Jersey序列化/反序列化到JSON的数据实体的类,expertion将能够生成那部分文档。 数据实体在不同的模块中,按照清晰的留档-多模块项目中的建议,将其源打包 这是我的发音.xml的样子: 文档的样子是这样的: 如您所见,响应体仅包含< code >元素:(custom
本文向大家介绍如何在HTML文档中包含Modernizr?,包括了如何在HTML文档中包含Modernizr?的使用技巧和注意事项,需要的朋友参考一下 Modernizr提供了一种检测任何新功能的简便方法,因此您可以采取相应的措施。例如,如果浏览器不支持视频功能,那么您想显示一个简单的页面。 您可以根据功能的可用性创建CSS规则,如果浏览器不支持新功能,这些规则将自动应用于网页。 您可以从Mode
我正在使用,我已经能够获得一个html页面并为该页面生成pdf,但我需要从多个html页面生成一个pdf文档,并用页面分隔。例如:我有,。我需要一份3页的pdf文档,第一页的内容为之类的。。。 这是我的代码,它适用于一个html页面: 是否可以针对多个html页面进行循环,为每个html页面向PdfDocument添加一个新页面,然后仅生成一个pdf,每个html页面生成一个页面? 更新 我一直在
显然,自Android SDK 17以来,构建生成了一个名为BuildConfig的自动类,并将其添加到我的包中。http://android-developers.blogspot.com/2012/03/updated-sdk-tools-and-adt-revision-17.html说: 添加了一个功能,允许您仅在调试模式下运行某些代码。构建现在生成一个名为BuildConfig的类,该类
我在ubuntu 18.04上运行maven 3.6.0。 我的应用程序的pom.xml包括这个依赖项;关联的“neptus”jar在我的本地. m2/repository中: 我的应用程序实际上引用了“neptus”jar文件中的类,所以我想在我的项目的uberjar中包含这些类。因此,pom.xml也包括这个,改编自http://maven.apache.org/plugins/maven-s
问题内容: 我正在使用SASS的SCSS语法来创建动态网格系统,但是遇到了麻烦。 我试图像这样使网格系统完全动态: 然后我创建像这样的列: 哪个输出: 这很好用,但是 我接下来要做的是根据选择的$ columns的数目动态生成一列由逗号分隔的长列类 -例如,我希望它看起来像这样: 我已经累了: 但是输出是这样的: 我对这里的逻辑以及创建这样的东西所需的SCSS语法有些困惑。 有人有什么想法吗? 谢