2013-02-10 69 views
50

我怎样才能做一个私人领域的javadoc链接?如何将javadoc链接到私人领域?

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

{@link Foo#getBar()}的作品。

{@link Foo#bar}没有。

+6

为什么你要的javadoc链接到一些最终用户将无法看到? – 2013-02-10 10:50:03

+0

如果我重命名链接的内​​容,我经常使用@link让javadoc自动重命名。所以我想如果我有时候重命名“bar”,javadoc会相应地自动更新。 – membersound 2013-02-10 10:55:13

+4

@ X.L.Ant因为它对你也有好处,当你在明年看到这个私人领域时,并不知道这是什么意思。特别是当公共getter的javadoc只包含自动创建的javadoc注释:“getter method()” – AlexWien 2013-02-10 15:57:39

回答

77

的语法是好的,无论是在类中的以下工作(和没有理由链接到私人领域,从不同的类):

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

当生成javadoc的,例如,通过蚂蚁,只需指定私人领域应包括(默认最小访问是“受保护”,而不是“私有”):

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

我认为你在评论中写的是好的,你只需要告诉JavaDoc在文档中也包含私有字段。 JavaDoc有一个选项 - 专用于此。检查this answer