2013-02-10 36 views
50

मैं एक निजी क्षेत्र में जावाडोक लिंक कैसे बना सकता हूं?जावडोक को निजी क्षेत्र से कैसे लिंक करें?

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

{@link Foo#getBar()} काम करता है।

{@link Foo#bar} नहीं करता है।

+6

क्यों तुम कुछ अंतिम उपयोगकर्ताओं के लिए जावाडोक लिंक नहीं देखने के लिए सक्षम हो जाएगा चाहेगा? –

+0

यदि मैं जुड़ा हुआ हूं तो मैं अक्सर javadocs ऑटो-नामित होने के लिए @ लिंक करता हूं। तो मैंने सोचा कि अगर मैं कभी-कभी "बार" का नाम बदलता हूं, तो जावाडोक तदनुसार स्व-सूक्ष्म होगा। – membersound

+4

@ X.L.Ant क्योंकि यह आपके लिए भी अच्छा है, जब आप अगले वर्ष उस निजी क्षेत्र में देखते हैं, और आपको पता नहीं है कि इसका क्या अर्थ है। विशेष रूप से जब उस फील्ड के लिए सार्वजनिक गेटर के जावडोक में केवल ऑटो निर्मित जावाडोक टिप्पणी होती है: "गेटर विधि()" – AlexWien

उत्तर

77

वाक्य रचना ठीक एक वर्ग के भीतर निम्नलिखित काम दोनों है, (और वहाँ एक अलग वर्ग से एक निजी क्षेत्र से जोड़ने के लिए कोई कारण नहीं है):

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

जब जावाडोक पैदा करने, जैसे, चींटी के माध्यम से, बस निर्दिष्ट है कि निजी क्षेत्रों शामिल किया जाना चाहिए (डिफ़ॉल्ट न्यूनतम पहुँच "संरक्षित" है, "निजी" नहीं):

<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

मुझे लगता है कि आप टिप्पणियों में जो लिख रहे हैं वह ठीक है, आपको केवल दस्तावेज़ों में निजी फ़ील्ड शामिल करने के लिए जावाडोक को बताने की आवश्यकता है। जावाडॉक के पास एक विकल्प है - इसके लिए निजी। this answer देखें।