Cara menghasilkan komentar javadoc di Android Studio


204

Bisakah saya menggunakan tombol pintas di studio Android untuk menghasilkan komentar javadoc?

Jika tidak, apa cara termudah untuk menghasilkan komentar javadoc?


Pertanyaan ini 50/50. Anda juga mencari blok javadoc tunggal untuk menghasilkan javadoc di seluruh dokumen. Yang mana itu?
K - Keracunan dalam SO tumbuh.

ALTR + ENTER menunjukkan tampilan Anda dapat menghasilkan komentar dari metode yang sudah dinyatakan.
Zala Janaksinh

Mungkin Anda harus menambahkan template hidup (Android studio - setting - editor - Live Templates - add) untuk itu. Di bidang teks templat, tambahkan teks berikut. / ** * $ komentar $ * /
Johnett Mathew

Jawaban:


388

Saya tidak dapat menemukan jalan pintas untuk menghasilkan komentar javadoc. Tetapi jika Anda mengetik /**sebelum deklarasi metode dan menekan Enter, blok komentar javadoc akan dihasilkan secara otomatis.

Baca ini untuk informasi lebih lanjut.


7
Ini memalukan bahwa ini tidak juga berfungsi untuk menghasilkan komentar javadoc untuk kelas, bidang, dll. Akan lebih baik jika menghasilkan javadoc dari templat yang dapat disesuaikan.
Ted Hopp

23
tentu saja ada jalan pintas: posisi pada metode / nama konstruktor dan tekan alt + enter, pilih menghasilkan javadoc dari menu
Ewoks

lihat ini lebih lanjut tentang solusi di atas
Pritesh Vishwakarma

110

Untuk membuat komentar ketik /**kunci sebelum deklarasi metode dan tekan Enter. Ini akan menghasilkan komentar javadoc.

Contoh:

/**
* @param a
* @param b
*/

public void add(int a, int b) {
    //code here
}

Untuk informasi lebih lanjut, periksa tautan https://www.jetbrains.com/idea/features/javadoc.html


4
@satheeshwaran - benarkah? Ini jawaban yang sama dengan yang dari DouO (jawaban asli), kecuali punya contoh. Bahkan tautannya adalah salinan. Contoh seharusnya ditambahkan ke jawaban yang asli.
CJBS

3
@satheeshwaran - untuk apa nilainya, saya dapat melihat bahwa hanya melihat contoh komentar (dalam jawaban) berguna, ketika seseorang menginginkan jawaban dengan cepat ;-)
CJBS

Sebenarnya contoh tidak memiliki * sebelum yang terakhir /
Maximiliano Ambrosini

35

Berikut adalah contoh komentar JavaDoc dari Oracle :

/**
 * Returns an Image object that can then be painted on the screen. 
 * The url argument must specify an absolute {@link URL}. The name
 * argument is a specifier that is relative to the url argument. 
 * <p>
 * This method always returns immediately, whether or not the 
 * image exists. When this applet attempts to draw the image on
 * the screen, the data will be loaded. The graphics primitives 
 * that draw the image will incrementally paint on the screen. 
 *
 * @param  url  an absolute URL giving the base location of the image
 * @param  name the location of the image, relative to the url argument
 * @return      the image at the specified URL
 * @see         Image
 */
 public Image getImage(URL url, String name) {
        try {
            return getImage(new URL(url, name));
        } catch (MalformedURLException e) {
            return null;
        }
 }

Format dasar dapat dibuat secara otomatis dengan salah satu cara berikut:

  • Posisikan kursor di atas metode dan ketik /**+Enter
  • Posisikan kursor pada nama metode dan tekan Alt+ Enter> klik Tambah JavaDoc masukkan deskripsi gambar di sini

17

Anda dapat menginstal plugin JavaDoc dari Pengaturan-> Plugin-> Jelajahi repositori.

dapatkan dokumentasi plugin dari tautan di bawah ini

Dokumen plugin JavaDoc

masukkan deskripsi gambar di sini


Ini sangat bagus. Instal plugin JavaDoc (seperti di atas), lalu tekan CNTL + SHIFT + ALT + G.
Alan Nelson

10

Anda dapat menggunakan gaya gerhana dari generasi komentar JavaDoc melalui "Perbaiki komentar doc". Buka "Preferensi" -> "Keymap" dan tetapkan tindakan "Perbaiki komentar doc" ke kunci yang Anda inginkan.


9

Di sini kita dapat sesuatu seperti ini. Dan alih-alih menggunakan jalan pintas apa pun, kita dapat menulis komentar "default" di tingkat kelas / paket / proyek. Dan memodifikasi sesuai kebutuhan

   *** Install JavaDoc Plugin ***



     1.Press shift twice and  Go to Plugins.
     2. search for JavaDocs plugin
     3. Install it. 
     4. Restart Android Studio.
     5. Now, rightclick on Java file/package and goto 
        JavaDocs >> create javadocs for all elements
        It will  generate all default comments.

Keuntungannya adalah, Anda dapat membuat blok komentar untuk all the methods at a time.


9

Komentar Javadoc dapat ditambahkan secara otomatis dengan menggunakan fitur autocomplete IDE Anda. Coba ketikkan /**dan tekan Enteruntuk menghasilkan sampel komentar Javadoc.

 /**
 *
 * @param action          The action to execute.
 * @param args            The exec() arguments.
 * @param callbackContext The callback context used when calling back into JavaScript.
 * @return
 * @throws JSONException
 */

5

Di Android Studio Anda tidak perlu plug-in. Pada Mac cukup buka Android Studio -> klik Android Studio di bar bagian atas -> klik Prefrences -> temukan File dan Code Templat dalam daftar -> pilih include -> build it dan akan bertahan di semua proyek Anda


2
  • Cara lain untuk menambahkan komentar java docs adalah tekan: Ctrl + Shift + A >> tampilkan popup >> ketik: Add javadocs >> Enter.

  • Ctrl + Shirt + A: Command look-up (nama perintah autocomplete)

masukkan deskripsi gambar di sini


2

Cukup pilih (mis. Klik) nama metode, lalu gunakan kombo tombol Alt + Enter, pilih "Tambah JavaDoc"

Ini mengasumsikan bahwa Anda belum menambahkan komentar di atas metode, kalau tidak opsi "Tambahkan JavaDoc" tidak akan muncul.


2

Di studio Android kami memiliki beberapa cara untuk menghasilkan komentar secara otomatis:

  • Metode I:

Dengan mengetikkan / ** dan kemudian menekan Enter Anda dapat menghasilkan baris komentar berikutnya dan itu akan secara otomatis menghasilkan params, dll. Tetapi ketika Anda memerlukan hotkey untuk ini periksa metode II di bawah ini.

  • ** Metode II: **

1 - Goto topMenu

2 - File> Pengaturan

3 - Pilih Keymap dari pengaturan

4 - Di bar pencarian kanan atas cari "Fix Doc"

5 - Pilih "fix doc comment" dari hasil dan klik dua kali

6 - Pilih Tambahkan pintasan keyboard dari drop down yang terbuka setelah klik dua kali

7 - Tekan tombol pintas pada keyboard

8 - Ambil kode Anda dan di mana Anda ingin menambahkan beberapa komentar tekan tombol pintas

9 - Selamat Menikmati!


Cara paling meyakinkan untuk menambahkan dokumen. Misalnya saya telah menetapkan "'" dan Masukkan sebagai pintasan
CodeToLife

1

Cukup pilih versi Eclipse dari keycap di pengaturan Keymap. Eclipse Keymap termasuk dalam Android Studio.


0

Saya tidak yakin saya sepenuhnya memahami pertanyaannya, tetapi daftar jalan pintas keyboard dapat ditemukan di sini - Semoga ini bisa membantu!


2
Dalam gerhana untuk menambahkan komentar javadoc tekan Alt + shift + j, tetapi di AndroidStudio tapi saya tidak tahu bagaimana melakukannya
qinxianyuzou

Jika saya ingat, pintasan itu hanya berfungsi jika Anda memasang dan mengaktifkan plugin 'jautodoc'.
Matt

0

Android Studio -> Preferensi -> Editor -> Niat -> Java -> Deklarasi -> Aktifkan "Tambah JavaDoc"

Dan, Saat memilih Metode untuk Diimplementasikan (Ctrl / Cmd + i), di bagian kiri bawah, Anda akan melihat kotak centang untuk mengaktifkan Salin JavaDoc.



-5

ALT+ SHIFT+ Gakan membuat komentar yang dihasilkan secara otomatis untuk metode Anda (tempatkan kursor pada posisi awal metode Anda).


public void hideKeyboard () Anda harus meletakkan kursor di depan publik dan mencobanya atau silakan periksa apakah Anda menginstal java doc di studio Anda.
Dinesh IT

Ini juga tidak bekerja untuk saya. Mungkin, ini bekerja di beberapa tombol khusus. Keymap dapat dikonfigurasi di Preferensi> Keymap. Atau keymap telah diedit.
Oliver Kranz
Dengan menggunakan situs kami, Anda mengakui telah membaca dan memahami Kebijakan Cookie dan Kebijakan Privasi kami.
Licensed under cc by-sa 3.0 with attribution required.