草庐IT

java - 您如何链接到 javadoc 中的_包描述_(不是类)？

coder 2024-03-04 原文

(不，这不是重复的，见下文)

就其值(value)而言，这是 Oracle JDK，7u72。

虽然我确实需要链接到包描述，但我无法设法链接到包描述，因为其中提到了重要信息，但我每次都没有这样做；当我尝试 {@link my.package.name} 或告诉人们去 @see my.package.name (甚至是指向包描述的链接外部库)，javadoc 工具报告找不到链接...

那么，我该如何建立这样的链接呢？

好的，所以，被告知here是答案，但不是:

  • 建议的解决方案仅适用于您自己代码中的包；我希望能够链接到其他库的包描述；
  • 我希望此类链接在 package-info.java 和“普通”类 javadoc 中也有效。

所以，这不是重复的。

最佳答案

它不像使用 {@link package.class#member} 那样简单标记语法，但您可以直接使用 <a href="..."> 链接到包文档HTML 标记。关键是知道要放置在 href 属性中的正确 URI。

Javadoc 输出文件 arranged in a directory tree与您的包结构相匹配。对于每个包，其描述始终包含在名为 package-summary.html 的文件中位于其相应的目录中。实际的描述文本 位于特定 anchor 处或附近，这因 Doclet 版本而异。 anchor 名称可以附加为 fragment identifier如果您希望直接跳转到描述正文而不是包页面顶部，请转到下面的任何 URI。

  • 在 Java 7 中，包描述 anchor 被命名为 description , 表示为片段标识符 #description .
  • 在 Java 8 中， anchor 被重命名为 package.description , 表示为片段标识符 #package.description .

本地文档(在您自己的代码中导航包):

  • 在任何类中，要引用其自己的包:
    <a href="package-summary.html">link text</a>

  • 在类里面 com.example.foo.MyClass引用com.example 父*包:
    <a href="../package-summary.html">link text</a>

  • 在类里面 com.example.foo.MyClass引用com.example.bar 兄弟* 包裹:
    <a href="../bar/package-summary.html">link text</a>

  • 在类里面 com.example.foo.MyClass引用com.example.foo.fizz.buzz child * 包裹:
    <a href="fizz/buzz/package-summary.html">link text</a>

这些例子都假定目标包实际上是包；换句话说，该级别存在该类。如果相反 com.example是所有包的公共(public)前缀，但不是声明的单个类 package com.example;那么上面的第二个示例将是一个死链接，因为不会在com/example/package-summary.html 生成摘要文件。

最大的缺点是，如果您重组或重命名包，重构工具不太可能修复 Javadoc 中的链接。

*是的，我理解逻辑上，在 Java 中，包没有正式的“父”或“子”关系。但是，用于将文件组织到包中的目录结构确实具有父子语义，这就是我在这里所指的内容。

远程文档(从 URL 或文件路径链接):

链接文档的工作方式与本地文档基本相同，但具有不同的 anchor 标记 HREF 目标。例如，链接到 Web 上的公共(public)文档将使用绝对 http://地址。链接到本地​​或公司文件系统上其他地方的另一个库也可能使用相对或绝对路径。

请记住，当使用 Javadoc 工具的链接功能时，它基本上做同样的事情。它读取 package-list链接目录树中的文件以了解远程端存在哪些包，然后来自这些包的任何引用文档在生成的链接中使用适当的 URI。

出于示例目的，假设您从以下位置链接到 Java API:
http://docs.oracle.com/javase/7/docs/api/

然后引用java.util.concurrent包描述，附加java/util/concurrent/目录结构到基本 URI，并添加 package-summary.html在末尾。 (或者只是从您的 Web 浏览器中复制它。):-)

http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/package-summary.html

同样，如果外部 API 文档移动(咳咳，Oracle)，那么当您更新 Javadoc 配置以指向新链接时，您的 {@link ...} 会再次出现一个缺点。标记可能有效，但这些包文件的任何手写 HTML 标记都将过时。

关于java - 您如何链接到 javadoc 中的_包描述_(不是类)？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/27462652/

javadocjavacodepackagepackage-summary

有关java - 您如何链接到 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 - 其他文件中的 Rake 任务 - 2

    我试图在一个项目中使用rake，如果我把所有东西都放到Rakefile中，它会很大并且很难读取/找到东西，所以我试着将每个命名空间放在lib/rake中它自己的文件中，我添加了这个到我的rake文件的顶部:Dir['#{File.dirname(__FILE__)}/lib/rake/*.rake'].map{|f|requiref}它加载文件没问题，但没有任务。我现在只有一个.rake文件作为测试，名为“servers.rake”，它看起来像这样:namespace:serverdotask:testdoputs"test"endend所以当我运行rakeserver:testid时

  4. ruby-on-rails - Ruby net/ldap 模块中的内存泄漏 - 2

    作为我的Rails应用程序的一部分，我编写了一个小导入程序，它从我们的LDAP系统中吸取数据并将其塞入一个用户表中。不幸的是，与LDAP相关的代码在遍历我们的32K用户时泄漏了大量内存，我一直无法弄清楚如何解决这个问题。这个问题似乎在某种程度上与LDAP库有关，因为当我删除对LDAP内容的调用时，内存使用情况会很好地稳定下来。此外，不断增加的对象是Net::BER::BerIdentifiedString和Net::BER::BerIdentifiedArray，它们都是LDAP库的一部分。当我运行导入时，内存使用量最终达到超过1GB的峰值。如果问题存在，我需要找到一些方法来更正我的代

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

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

  6. ruby-on-rails - Rails 3 中的多个路由文件 - 2

    Rails2.3可以选择随时使用RouteSet#add_configuration_file添加更多路由。是否可以在Rails3项目中做同样的事情？ 最佳答案 在config/application.rb中:config.paths.config.routes在Rails3.2(也可能是Rails3.1)中，使用:config.paths["config/routes"] 关于ruby-on-rails-Rails3中的多个路由文件，我们在StackOverflow上找到一个类似的问题

  7. 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

  8. 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

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

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

  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

随机推荐