මම එය භාවිතා කරන්නේ කෙසේද? @linkක්‍රමයකට සම්බන්ධ වීමට ටැගය ?

මට වෙනස් කිරීමට අවශ්‍යයි:

/**
 * Returns the Baz object owned by the Bar object owned by Foo owned by this.
 * A convenience method, equivalent to getFoo().getBar().getBaz()
 * @return baz
 */
public Baz fooBarBaz()

වෙත:

/**
 * Returns the Baz object owned by the Bar object owned by Foo owned by this.
 * A convenience method, equivalent to {@link getFoo()}.{@link getBar()}.{@link getBaz()}
 * @return baz
 */
public Baz fooBarBaz()

නමුත් @linkටැගය නිවැරදිව සංයුති කරන්නේ කෙසේදැයි මම නොදනිමි .

ජාවාඩොක් පිළිබඳ බොහෝ තොරතුරු සම්මත ඩොක්ලට් සඳහා වන ප්‍රලේඛන විවරණ පිරිවිතරයෙන් ඔබට හමුවනු ඇත.

package inklink package.class # සාමාජික ලේබලය}

ටැගය (ඔබ සොයන බව). ප්‍රලේඛනයෙන් අනුරූප උදාහරණය පහත පරිදි වේ

උදාහරණයක් ලෙස, getComponentAt (int, int) ක්‍රමයට යොමු වන අදහස් දැක්වීමක් මෙන්න:

Use the {@link #getComponentAt(int, int) getComponentAt} method.

මෙම package.classයොමු ක්රමය වර්තමාන පන්තියේ නම් කොටසක් ommited කළ හැක.

JavaDoc පිළිබඳ වෙනත් ප්‍රයෝජනවත් සබැඳි:

• JavaDoc මෙවලම් යොමුව
• JavaDoc Guide
• Javadoc මෙවලම සඳහා Doc අදහස් ලියන ආකාරය

ජාවාඩොක් ප්‍රලේඛනයේ ink ලින්ක් කොටසේ සිට සාමාන්‍ය ආකෘතිය :

උදාහරණ

එකම පන්තියේ ක්‍රමය:

/** See also {@link #myMethod(String)}. */
void foo() { ... }

එකම පන්තියේ හෝ ආනයනය කළ වෙනත් පන්තියක ක්‍රමය :

/** See also {@link MyOtherClass#myMethod(String)}. */
void foo() { ... }

ආනයනය නොකළ වෙනත් පැකේජයක ක්‍රමය :

/** See also {@link com.mypackage.YetAnotherClass#myMethod(String)}. */
void foo() { ... }

කේත අකුරු වලට වඩා සරල පෙළකින් ලේබලය ක්‍රමයට සම්බන්ධ කර ඇත :

/** See also this {@linkplain #myMethod(String) implementation}. */
void foo() { ... }

ඔබේ ප්‍රශ්නයේදී මෙන් ක්‍රම ඇමතුම් දාමයකි . මෙම පංතියෙන් පිටත ක්‍රම සඳහා සබැඳි සඳහා ලේබල් නියම කළ යුතුය, නැතහොත් අපට ලැබේ getFoo().Foo.getBar().Bar.getBaz(). නමුත් ප්‍රතිනිර්මාණය කිරීමේදී මෙම ලේබල බිඳෙනසුලු විය හැකිය - පහත “ලේබල” බලන්න.

/**
 * A convenience method, equivalent to 
 * {@link #getFoo()}.{@link Foo#getBar() getBar()}.{@link Bar#getBaz() getBaz()}.
 * @return baz
 */
public Baz fooBarBaz()

ලේබල

ස්වයංක්‍රීය ප්‍රතිනිර්මාණය ලේබල් වලට බලපාන්නේ නැත. ක්‍රමය, පන්තිය හෝ පැකේජය නැවත නම් කිරීම මෙයට ඇතුළත් ය; සහ ක්‍රම අත්සන වෙනස් කිරීම.

එබැවින්, පෙරනිමියට වඩා වෙනස් පෙළක් අවශ්‍ය නම් පමණක් ලේබලයක් සපයන්න .

උදාහරණයක් ලෙස, ඔබට මිනිස් භාෂාවෙන් කේතයට සම්බන්ධ විය හැකිය:

/** You can also {@linkplain #getFoo() get the current foo}. */
void setFoo( Foo foo ) { ... }

නැතහොත් "ක්‍රම ඇමතුම් දාමයක්" යටතේ ඉහත පෙන්වා ඇති පරිදි පෙරනිමියට වඩා වෙනස් පෙළක් සහිත කේත නියැදියකින් ඔබට සම්බන්ධ විය හැකිය. කෙසේ වෙතත්, API පරිණාමය වෙමින් තිබියදී මෙය බිඳෙන සුළු විය හැකිය.

මකාදැමීම සහ # මතක තබා ගන්න

ක්‍රම අත්සනට පරාමිතිගත කළ වර්ග තිබේ නම්, javadoc inklink හි එම වර්ග මකාදැමීම භාවිතා කරන්න. උදාහරණයක් වශයෙන්:

int bar( Collection<Integer> receiver ) { ... }

/** See also {@link #bar(Collection)}. */
void foo() { ... }

ඔබට එය කිරීමට භාවිතා කළ හැකිය @see:

නියැදිය:

interface View {
        /**
         * @return true: have read contact and call log permissions, else otherwise
         * @see #requestReadContactAndCallLogPermissions()
         */
        boolean haveReadContactAndCallLogPermissions();

        /**
         * if not have permissions, request to user for allow
         * @see #haveReadContactAndCallLogPermissions()
         */
        void requestReadContactAndCallLogPermissions();
    }