Bagaimana saya bisa menggunakan @linktag untuk menautkan ke suatu metode?

Saya ingin berubah:

/**
 * 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()

untuk:

/**
 * 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()

tapi saya tidak tahu cara memformat @linktag dengan benar.

Anda akan menemukan banyak informasi tentang JavaDoc di Spesifikasi Komentar Dokumentasi untuk Doclet Standar , termasuk informasi di

{@link package.class # label anggota}

tag (yang Anda cari). Contoh yang sesuai dari dokumentasi adalah sebagai berikut

Sebagai contoh, berikut adalah komentar yang merujuk pada metode getComponentAt (int, int):

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

Bagian package.classdapat dihentikan jika metode yang dimaksud adalah di kelas saat ini.

Tautan bermanfaat lainnya tentang JavaDoc adalah:

• Referensi Alat JavaDoc
• Panduan JavaDoc
• Cara Menulis Komentar Doc untuk Alat Javadoc

Format umum, dari bagian @link dari dokumentasi javadoc , adalah:

Contohnya

Metode di kelas yang sama:

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

Metode di kelas yang berbeda, baik dalam paket yang sama atau diimpor:

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

Metode dalam paket berbeda dan tidak diimpor:

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

Label yang ditautkan dengan metode, dalam teks biasa, bukan font kode:

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

Rantai panggilan metode, seperti dalam pertanyaan Anda. Kita harus menentukan label untuk tautan ke metode di luar kelas ini, atau kita dapatkan getFoo().Foo.getBar().Bar.getBaz(). Tetapi label ini bisa rapuh; lihat "Label" di bawah ini.

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

Label

Refactoring otomatis mungkin tidak mempengaruhi label. Ini termasuk mengganti nama metode, kelas atau paket; dan mengubah tanda tangan metode.

Karena itu, berikan label hanya jika Anda ingin teks yang berbeda dari yang standar.

Misalnya, Anda dapat menautkan dari bahasa manusia ke kode:

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

Atau Anda dapat menautkan dari sampel kode dengan teks yang berbeda dari standar, seperti yang ditunjukkan di atas di bawah "Rantai panggilan metode". Namun, ini bisa rapuh saat API sedang berkembang.

Ketik erasure dan #member

Jika tanda tangan metode menyertakan tipe parameter, gunakan penghapusan tipe tersebut di javadoc @link. Sebagai contoh:

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

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

Anda dapat menggunakannya @seeuntuk melakukan itu:

Sampel:

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();
    }