如何將javadoc鏈接到私人領域？

我怎樣才能做一個私人領域的javadoc鏈接？如何將javadoc鏈接到私人領域？

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

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

{@link Foo#bar}沒有。

來源

2013-02-10 membersound

爲什麼你要的javadoc鏈接到一些最終用戶將無法看到？ – 2013-02-10 10:50:03

如果我重命名鏈接的內容，我經常使用@link讓javadoc自動重命名。所以我想如果我有時候重命名「bar」，javadoc會相應地自動更新。 – membersound 2013-02-10 10:55:13

@ X.L.Ant因爲它對你也有好處，當你在明年看到這個私人領域時，並不知道這是什麼意思。特別是當公共getter的javadoc只包含自動創建的javadoc註釋：「getter method（）」 – AlexWien 2013-02-10 15:57:39

的語法是好的，無論是在類中的以下工作（和沒有理由鏈接到私人領域，從不同的類）：

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>

來源

2013-02-10 11:15:33 michael

我認爲你在評論中寫的是好的，你只需要告訴JavaDoc在文檔中也包含私有字段。 JavaDoc有一個選項 - 專用於此。檢查this answer。

來源

2013-02-10 10:54:53 damix911

如何將javadoc鏈接到私人領域？

回答

相關問題