草庐IT

java - 内部/嵌套类构造函数的正确 "@link"或 "@see"javadoc 标记是什么？

coder 2024-04-02 原文

我在让“@link”和“@see”标签为内部/嵌套类的构造函数工作时遇到了问题，希望这里有人能提供帮助。这个简短的示例类在第 25 行给出了 javadoc 警告，引用了“Layer()”文档前面几行中的“@link”和(等效的)“@see”标记。

package bogus;
import javax.swing.JPanel;
public class LayeredPlot extends JPanel {
  /**
   * Constructor for the plot.
   */
  public LayeredPlot() {
  }
  public static class Layer {
    private String name;
    /**
     * Construct a default layer with a default name. This method calls
     * {@link LayeredPlot.Layer#Layer(String)} OR calls == JAVADOC WARNING
     * {@link #Layer(String)} OR calls                  == JAVADOC WARNING
     * {@link Layer#Layer(String)}                      == JAVADOC WARNING
     * with a null name to perform the construction.
     * The constructor for the layer can be found
     * {@link LayeredPlot#LayeredPlot() here}.          == JAVADOC Okay!
     *
     * @see LayeredPlot.Layer#Layer(String)             == JAVADOC WARNING
     * @see #Layer(String)                              == JAVADOC WARNING
     * @see Layer#Layer(String)                         == JAVADOC WARNING
     * @see LayeredPlot#LayeredPlot()                   == JAVADOC Okay!
     */
    public Layer() {    // Line 25: javadoc warnings reference this line
      this(null);
    }
    /**
     * Construct a layer with the specified name.
     *
     * @param name The desired name for the layer within the plot.
     */
    public Layer(String name) {
      this.name = name;
    }
  }
}

警告(“@see”有 3 个，“@link”有 3 个)都说:can't find Layer(String) in bogus.LayeredPlot.Layer。

请注意:所有其他 javadoc 都按预期工作(包括内部类方法和我在本例中对 LayeredPlot 本身的构造函数的引用)。

对于内部/嵌套类构造函数的正确 javadoc 标记的任何建议将不胜感激。
谢谢。

最佳答案

由于 bug JDK-8031625，Java 8 或更早版本没有正确的方法来做到这一点，仅在 Java 9 中修复。

解决方法是对类和参数使用完全限定的名称:

{@link bogus.LayeredPlot.Layer#LayeredPlot.Layer(java.lang.String)}

但这不是句法上有效的成员名称，因此一些工具会报错(doclint、checkstyle)。

关于java - 内部/嵌套类构造函数的正确 "@link"或 "@see"javadoc 标记是什么？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/40747275/

amp34LayerLayeredPlotStringjavajavadocinner-classes

有关java - 内部/嵌套类构造函数的正确 "@link"或 "@see"javadoc 标记是什么？的更多相关文章

  1. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法？ - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  2. ruby-on-rails - rails : "missing partial" when calling 'render' in RSpec test - 2

    我正在尝试测试是否存在表单。我是Rails新手。我的new.html.erb_spec.rb文件的内容是:require'spec_helper'describe"messages/new.html.erb"doit"shouldrendertheform"dorender'/messages/new.html.erb'reponse.shouldhave_form_putting_to(@message)with_submit_buttonendendView本身，new.html.erb，有代码:当我运行rspec时，它失败了:1)messages/new.html.erbshou

  3. ruby-on-rails - 由于 "wkhtmltopdf"，PDFKIT 显然无法正常工作 - 2

    我在从html页面生成PDF时遇到问题。我正在使用PDFkit。在安装它的过程中，我注意到我需要wkhtmltopdf。所以我也安装了它。我做了PDFkit的文档所说的一切......现在我在尝试加载PDF时遇到了这个错误。这里是错误:commandfailed:"/usr/local/bin/wkhtmltopdf""--margin-right""0.75in""--page-size""Letter""--margin-top""0.75in""--margin-bottom""0.75in""--encoding""UTF-8""--margin-left""0.75in""-

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

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

  5. ruby-on-rails - Rails 编辑表单不显示嵌套项 - 2

    我得到了一个包含嵌套链接的表单。编辑时链接字段为空的问题。这是我的表格:Editingkategori{:action=>'update',:id=>@konkurrancer.id})do|f|%>'Trackingurl',:style=>'width:500;'%>'Editkonkurrence'%>|我的konkurrencer模型:has_one:link我的链接模型:classLink我的konkurrancer编辑操作:defedit@konkurrancer=Konkurrancer.find(params[:id])@konkurrancer.link_attrib

  6. ruby - 什么是填充的 Base64 编码字符串以及如何在 ruby​​ 中生成它们？ - 2

    我正在使用的第三方API的文档状态:"[O]urAPIonlyacceptspaddedBase64encodedstrings."什么是“填充的Base64编码字符串”以及如何在Ruby中生成它们。下面的代码是我第一次尝试创建转换为Base64的JSON格式数据。xa=Base64.encode64(a.to_json) 最佳答案 他们说的padding其实就是Base64本身的一部分。它是末尾的“=”和“==”。Base64将3个字节的数据包编码为4个编码字符。所以如果你的输入数据有长度n和n%3=1=>"=="末尾用于填充n%

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

  8. ruby - 将散列转换为嵌套散列 - 2

    这道题是thisquestion的逆题.给定一个散列，每个键都有一个数组，例如{[:a,:b,:c]=>1,[:a,:b,:d]=>2,[:a,:e]=>3,[:f]=>4,}将其转换为嵌套哈希的最佳方法是什么{:a=>{:b=>{:c=>1,:d=>2},:e=>3,},:f=>4,} 最佳答案 这是一个迭代的解决方案，递归的解决方案留给读者作为练习:defconvert(h={})ret={}h.eachdo|k,v|node=retk[0..-2].each{|x|node[x]||={};node=node[x]}node[

  9. ruby - 为什么 4.1%2 使用 Ruby 返回 0.0999999999999996？但是 4.2%2==0.2 - 2

    为什么4.1%2返回0.0999999999999996？但是4.2%2==0.2。 最佳答案 参见此处:WhatEveryProgrammerShouldKnowAboutFloating-PointArithmetic实数是无限的。计算机使用的位数有限(今天是32位、64位)。因此计算机进行的浮点运算不能代表所有的实数。0.1是这些数字之一。请注意，这不是与Ruby相关的问题，而是与所有编程语言相关的问题，因为它来自计算机表示实数的方式。 关于ruby-为什么4.1%2使用Ruby返

  10. ruby - 检查 "command"的输出应该包含 NilClass 的意外崩溃 - 2

    为了将Cucumber用于命令行脚本，我按照提供的说明安装了arubagem。它在我的Gemfile中，我可以验证是否安装了正确的版本并且我已经包含了require'aruba/cucumber'在'features/env.rb'中为了确保它能正常工作，我写了以下场景:@announceScenario:Testingcucumber/arubaGivenablankslateThentheoutputfrom"ls-la"shouldcontain"drw"假设事情应该失败。它确实失败了，但失败的原因是错误的:@announceScenario:Testingcucumber/ar

随机推荐