草庐IT

java - 如何使生成的类包含来自 XML 模式文档的 Javadoc

coder 2024-07-01 原文

我目前正在使用具有 <xsd:annotation> 的 XML 模式/<xsd:documentation>在大多数类型和元素上。当我从这个 XML 模式生成 Java Bean 时，这些 Bean 的 Javadoc 只包含一些关于类型/元素的允许内容的通用生成信息。

我想查看 <xsd:documentation> 的内容在相关位置标记(例如，complextType 的该标记的内容应显示在生成的类的 Javadoc 中以表示该 complexType)。

有什么办法可以实现吗？

编辑:此 XML 架构将在带有 JAX-WS 的 WSDL 中使用，因此此标记也可能适用。

编辑 2:我读过 <jxb:javadoc> .据我了解，我可以在单独的 JAXB 绑定(bind)文件中或直接在 XML 模式中指定。那几乎可以解决我的问题。但我宁愿使用现有的 <xsd:documentation>标记，因为 Javadoc 不是文档的主要目标(它主要是关于数据结构的信息，而不是关于从中生成的 Java Beans 的信息)，并且允许非 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>元素。

将 child 添加到 <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 是“类”或“属性”。

对于一个包裹，你写一个 child 到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 生成文档，但这并没有回答问题。

关于java - 如何使生成的类包含来自 XML 模式文档的 Javadoc，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/2825444/

Javadocjavacodexsdgtjaxbjax-wsxjc

有关java - 如何使生成的类包含来自 XML 模式文档的 Javadoc的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri，根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法？ - 2

    总的来说，我对ruby​​还比较陌生，我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础，我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序，它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重，我想提高压缩级别，因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗？是否有另一个允许指定压缩级别的Ruby库？ 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  4. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声？ - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点？我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等)，但我确实想创建一个输出文件。

  5. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

    给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息？ 最佳答案 在Rails3中，update_all不返回任何有意义的信息，除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

  6. ruby-on-rails - Rails - 子类化模型的设计模式是什么？ - 2

    我有一个模型:classItem项目有一个属性“商店”基于存储的值，我希望Item对象对特定方法具有不同的行为。Rails中是否有针对此的通用设计模式？如果方法中没有大的if-else语句，这是如何干净利落地完成的？ 最佳答案 通常通过Single-TableInheritance. 关于ruby-on-rails-Rails-子类化模型的设计模式是什么？，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.co

  7. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗？当我运行compasswatch时，它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行？文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们？我自己编译的.sass文件编译成compiled/t

  8. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

    我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

  9. ruby - 解析 RDFa、微数据等的最佳方式是什么，使用统一的模式/词汇(例如 schema.org)存储和显示信息 - 2

    我主要使用Ruby来执行此操作，但到目前为止我的攻击计划如下:使用gemsrdf、rdf-rdfa和rdf-microdata或mida来解析给定任何URI的数据。我认为最好映射到像schema.org这样的统一模式，例如使用这个yaml文件，它试图描述数据词汇表和opengraph到schema.org之间的转换:#SchemaXtoschema.orgconversion#data-vocabularyDV:name:namestreet-address:streetAddressregion:addressRegionlocality:addressLocalityphoto:i

  10. ruby - 如何指定 Rack 处理程序 - 2

    Rackup通过Rack的默认处理程序成功运行任何Rack应用程序。例如:classRackAppdefcall(environment)['200',{'Content-Type'=>'text/html'},["Helloworld"]]endendrunRackApp.new但是当最后一行更改为使用Rack的内置CGI处理程序时，rackup给出“NoMethodErrorat/undefinedmethod`call'fornil:NilClass”:Rack::Handler::CGI.runRackApp.newRack的其他内置处理程序也提出了同样的反对意见。例如Rack

随机推荐