Android Studio'da javadoc yorumları nasıl oluşturulur?


204

Javadoc yorumları oluşturmak için Android stüdyosundaki kısayol tuşlarını kullanabilir miyim?

Değilse, javadoc yorumları oluşturmanın en kolay yolu nedir?


Bu soru 50/50. Ya belge boyunca tek javadoc üreten javadoc blokları arıyorsunuz. Hangisi?
K - SO'da toksisite artıyor.

ALTR + ENTER, önceden bildirilmiş yöntemlerin yorumunu oluşturabileceğiniz görünümü gösterir.
Zala Janaksinh

Bunun için bir Canlı şablon (Android stüdyo - ayar - editör - Canlı Şablonlar - ekle) eklemelisiniz. Şablon metin alanına aşağıdaki metni ekleyin. / ** * $ comment $ * /
Johnett Mathew

Yanıtlar:


388

Javadoc yorumları oluşturmak için herhangi bir kısayol bulamıyorum. Ancak /**yöntem bildiriminden önce yazıp Enter tuşuna basarsanız, javadoc yorum bloğu otomatik olarak oluşturulur.

Daha fazla bilgi için bunu okuyun .


7
Bunun, sınıflar, alanlar, vb. İçin javadoc yorumları oluşturmak için çalışmadığı bir utanç. Özelleştirilebilir bir şablondan javadoc üretmesi daha da güzel olurdu.
Ted Hopp

23
tabii ki kısayolu vardır: yöntem / yapıcı adı üzerinde konum ve alt + enter tuşlarına basın, menüden javadoc oluştur seçin
Ewoks

bakın bu daha hakkında yukarıdaki çözüm
Pritesh Vishwakarma

110

Yorum oluşturmak için /**, yöntem bildiriminden önce anahtar yazın ve tuşuna basın Enter. Javadoc yorumu üretecek.

Misal:

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

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

Daha fazla bilgi için https://www.jetbrains.com/idea/features/javadoc.html bağlantısını kontrol edin


4
@satheeshwaran - gerçekten mi? Bu bir örnek olması dışında DouO'dan gelen cevapla aynıdır (orijinal cevap). Bağlantı bile bir kopya. Örnek orijinal yanıta eklenmiş olmalıdır.
CJBS

3
@satheeshwaran - değerinde ne için, hızlı bir şekilde bir cevap istediğinde (cevapta) sadece yorumların örneğini görmenin yararlı olduğunu görebiliyorum ;-)
CJBS

Aslında örnekte sondan önce * yok /
Maximiliano Ambrosini

35

İşte Oracle bir javadoc yorum örneğidir :

/**
 * 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;
        }
 }

Temel biçim aşağıdaki yollardan biriyle otomatik olarak oluşturulabilir:

  • İmleci yöntemin üzerine getirin ve /**+ yazınEnter
  • İmleci yöntem adına getirin ve Alt+ tuşuna basın Enter> JavaDoc Ekle'yi tıklatın resim açıklamasını buraya girin

17

JavaDoc eklentisini Ayarlar-> Eklenti-> Depolara gözat seçeneklerinden yükleyebilirsiniz.

aşağıdaki linkten eklenti belgeleri alın

JavaDoc eklenti belgesi

resim açıklamasını buraya girin


Harika çalışıyor. JavaDoc eklentisini yükleyin (yukarıdaki gibi), ardından CNTL + ÜST KRKT + ALT + G tuşlarına basın
Alan Nelson

10

"Doc doc fix" ile JavaDoc yorum oluşturma tutulması stilini kullanabilirsiniz. "Tercih" -> "Tuş Haritası" nı açın ve istediğiniz bir tuşa "Belge açıklamasını düzelt" eylemini atayın.


9

Burada böyle bir şey yapabiliriz. Ve herhangi bir kısayol kullanmak yerine sınıf / paket / proje düzeyinde "varsayılan" yorumlar yazabiliriz. Ve şartının olarak değiştirmek

   *** 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.

Avantajı, için yorum bloğu oluşturabilirsiniz all the methods at a time.


9

Javadoc yorumları IDE'nizin otomatik tamamlama özelliği kullanılarak otomatik olarak eklenebilir. Örnek bir Javadoc yorumu oluşturmak için yazmayı /**ve vurmayı deneyin Enter.

 /**
 *
 * @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

Android Studio'da eklentiye ihtiyacınız yoktur. Mac'te Android Studio'yu açın -> üst çubukta Android Studio'yu tıklayın -> Tercihler'i tıklayın -> listede Dosya ve Kod Şablonlarını bulun -> içerir'i seçin -> oluşturun ve tüm projenizde kalıcı olacak


2
  • Java belgeleri yorumu eklemenin başka bir yolu da basın: Ctrl + Üst Karakter + A >> açılır pencereyi göster >> yazın: Javadocs ekle >> Enter.

  • Ctrl + Gömlek + A: Komut araması (otomatik tamamlama komut adı)

resim açıklamasını buraya girin


2

Yöntem adını seçin (tıklayın), ardından Alt + Enter tuş kombinasyonunu kullanın, "JavaDoc Ekle" yi seçin

Bu, yöntemin üzerine henüz yorum eklemediğinizi varsayar, aksi takdirde "JavaDoc Ekle" seçeneği görünmez.


2

Android stüdyosunda yorumları otomatik olarak oluşturmanın birkaç yolu var:

  • Yöntem I:

/ ** yazıp Enter tuşuna basarak bir sonraki yorum satırını oluşturabilirsiniz ve parametreler, vb. Otomatik olarak oluşturulur. Ancak, aşağıdaki II.

  • ** Yöntem II: **

1 - En üste git

2 - Dosya> Ayarlar

3 - Ayarlardan Tuş Haritası'nı seçin

4 - Sağ üstteki arama çubuğunda "Fix Doc" için arama yapın

5 - Sonuçlardan "doküman yorumunu düzelt" i seçin ve üzerine çift tıklayın

6 - Çift tıkladıktan sonra açılan açılır menüden Klavye kısayolu ekle'yi seçin

7 - Klavyedeki kısayol tuşlarına basın

8 - Kodunuzu girin ve yorum eklemek istediğiniz yere kısayol tuşuna basın

9 - Keyfini çıkarın!


Doküman eklemenin en uygun yolu. Örneğin, "" "
atadım

1

Keymap ayarlarında tuş başlığının Eclipse sürümünü seçmeniz yeterlidir. Eclipse Keymap, Android Studio'ya dahildir.


0

Soruyu tamamen anladığımdan emin değilim, ancak klavye kısayollarının bir listesini burada bulabilirsiniz - Umarım bu yardımcı olur!


2
Tutulma javadoc yorumları eklemek için Alt + shift + j tuşlarına basın, ancak AndroidStudio'da ama nasıl yapacağımı bilmiyorum
qinxianyuzou

Hatırlıyorsam, bu kısayol yalnızca 'jautodoc' eklentisini yüklediyseniz ve etkinleştirdiyseniz işe yaradı.
Mat

0

Android Studio -> Tercihler -> Editör -> Niyetler -> Java -> Beyan - - "JavaDoc Ekle" yi etkinleştir

Ve Uygulanacak Yöntemleri (Ctrl / Cmd + i) seçerken, sol altta JavaDoc Kopyala özelliğini etkinleştirmek için onay kutusunu görüyor olmalısınız.



-5

ALT+ SHIFT+ Gyönteminiz için otomatik oluşturulan yorumları oluşturur (imleci yönteminizin başlangıç ​​konumuna getirin).


public void hideKeyboard () u imleci genelin önüne getirmeli ve denemeli ya da lütfen java doc'i stüdyonuza yükleyip yüklemediğini kontrol etmelisiniz.
Dinesh IT

Benim için de çalışmıyor. Belki bazı özel tuş haritalarında çalışıyor. Tuş haritası Tercihler> Tuş Haritası'nda yapılandırılabilir. Veya tuş haritası düzenlenmiştir.
Oliver Kranz
Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.