如何将javadoc链接到私有字段？

java javadoc

2022-08-31 09:39:23

如何使javadoc链接到私有字段？

class Foo {
  private String bar;
  public String getBar() { return bar; }
}

{@link Foo#getBar()}工程。

{@link Foo#bar}不。

答案 1

语法很好，以下两者都在类中工作（并且没有理由链接到来自不同类的私有字段）：

public class Demo {
  private int num = 0;
  /**
  * Access field {@link Demo#num} / {@link #num}  ...
  */
  private void foo() { ... }
...

当生成javadoc时，例如，通过ant，只需指定应包含私有字段（默认的最低访问权限是“受保护的”，而不是“私有”）：

<target name="javadoc" depends="compile" description="gen javadoc">
  <javadoc destdir="build/docs"
           author="true"
           version="true"
           use="true"
           access="private"
           windowtitle="Demo API">

    <fileset dir="src/main" defaultexcludes="yes">
      <include name="com/**"/>
    </fileset>

    <doctitle><![CDATA[<h1>Test</h1>]]></doctitle>
    <link offline="true" href="http://download.oracle.com/javase/6/docs/api/" packagelistLoc="doc"/>
  </javadoc>
</target>

答案 2

我认为你在注释中写的内容很好，你只需要告诉JavaDoc在文档中也包含私有字段。JavaDoc为此提供了一个选项-private。检查此答案。