2013-02-10 22 views
50

Özel alana javadoc bağlantısını nasıl yapabilirim?javadoc özel alana nasıl?

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

{@link Foo#getBar()} çalışır.

{@link Foo#bar} çalışmıyor.

+6

Neden görmek mümkün olmayacaktır şey nihai kullanıcılara javadoc bağlamak isteyeyim? –

+0

Bağlantılı olanı yeniden adlandırırsam javadocs'un otomatik olarak yeniden adlandırılması için sık sık @link'im. Bu yüzden, bazen "bar" ismini yeniden adlandırırsam javadoc'un buna göre otomatik olarak başlamasını düşündüm. – membersound

+4

@ X.L.Anti sizin için de iyi, gelecek sene bu özel alana baktığınızda ve ne anlama geldiği hakkında hiçbir fikriniz olmadığı için. Özellikle bu javadoc için sadece javadoc sadece otomatik oluşturulan javadoc yorum içeriyorsa, "getter method()" – AlexWien

cevap

77

sözdizimi, bir sınıf içinde aşağıdaki çalışma hem ince (ve özel alana bağlamak için hiçbir neden farklı sınıftan yoktur):

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

karınca yoluyla, örneğin javadoc oluştururken, sadece özel alanlar (varsayılan asgari erişimi, "özel" değil "korunmaktadır") dahil edilmesi gerektiğini belirtin:

<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

Sanırım yorumda yazdıklarınız gayet iyi, sadece JavaDoc'a belgelere özel alanlar eklemesini söylemelisiniz. JavaDoc'un bunun için bir seçeneği var. this answer'u kontrol edin.

İlgili konular