So generieren Sie Javadoc-Kommentare in Android Studio

Kann ich in Android Studio Tastenkombinationen verwenden, um Javadoc-Kommentare zu generieren?

Wenn nicht, was ist der einfachste Weg, um Javadoc-Kommentare zu generieren?

Ich kann keine Verknüpfung zum Generieren von Javadoc-Kommentaren finden. Wenn Sie jedoch /**vor der Methodendeklaration eingeben und die Eingabetaste drücken, wird der Javadoc-Kommentarblock automatisch generiert.

Lesen Sie dies für weitere Informationen.

Um Kommentare zu generieren, geben Sie /**vor der Methodendeklaration den Schlüssel ein und drücken Sie Enter. Es wird ein Javadoc-Kommentar generiert.

Beispiel:

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

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

Weitere Informationen finden Sie unter dem Link https://www.jetbrains.com/idea/features/javadoc.html

Hier ist ein Beispiel für einen JavaDoc-Kommentar von 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;
        }
 }

Das Grundformat kann auf eine der folgenden Arten automatisch generiert werden:

• Positionieren Sie den Cursor über der Methode und geben Sie /**+ einEnter
• Positionieren Sie den Cursor auf dem Methodennamen und drücken Sie Alt+ Enter> klicken Sie auf JavaDoc hinzufügen

Sie können das JavaDoc-Plugin über Einstellungen-> Plugin-> Repositorys durchsuchen installieren.

Die Plugin-Dokumentation erhalten Sie über den folgenden Link

JavaDoc-Plugin-Dokument

Sie können den Eclipse-Stil der JavaDoc-Kommentargenerierung über "Dokumentkommentar korrigieren" verwenden. Öffnen Sie "Einstellungen" -> "Keymap" und weisen Sie einer gewünschten Taste die Aktion "Dokumentkommentar korrigieren" zu.

Hier können wir so etwas machen. Und anstatt eine Verknüpfung zu verwenden, können wir "Standard" -Kommentare auf Klassen- / Paket- / Projektebene schreiben. Und je nach Anforderung ändern

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

Vorteil ist, dass Sie einen Kommentarblock für erstellen können all the methods at a time.

Javadoc-Kommentare können mithilfe der Autocomplete-Funktion Ihrer IDE automatisch angehängt werden. Versuchen Sie zu tippen /**und zu schlagen Enter, um einen Beispiel-Javadoc-Kommentar zu generieren.

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

In Android Studio benötigen Sie das Plug-In nicht. Öffnen Sie auf einem Mac einfach Android Studio -> klicken Sie in der oberen Leiste auf Android Studio -> klicken Sie auf Einstellungen -> suchen Sie Datei- und Codevorlagen in der Liste -> wählen Sie Includes aus -> erstellen Sie sie und bleibt in Ihrem gesamten Projekt bestehen

• Eine andere Möglichkeit, einen Kommentar zu Java-Dokumenten hinzuzufügen, ist das Drücken von: Strg + Umschalt + A >> Popup anzeigen >> Typ: Javadocs hinzufügen >> Eingabe.

• Strg + Shirt + A: Befehlssuche (Befehlsname automatisch vervollständigen)

Wählen Sie einfach den Methodennamen aus (dh klicken Sie darauf), verwenden Sie dann die Tastenkombination Alt + Eingabetaste und wählen Sie "JavaDoc hinzufügen".

Dies setzt voraus, dass Sie noch keine Kommentare über der Methode hinzugefügt haben, da sonst die Option "JavaDoc hinzufügen" nicht angezeigt wird.

In Android Studio gibt es einige Möglichkeiten, Kommentare automatisch zu generieren:

• Methode I:

Wenn Sie / ** eingeben und dann die Eingabetaste drücken, können Sie die nächste Kommentarzeile generieren. Die Parameter usw. werden automatisch generiert. Wenn Sie jedoch den Hotkey für diese Check-out-Methode II benötigen, siehe unten.

• ** Methode II: **

1 - Gehe zu topMenu

2 - Datei> Einstellungen

3 - Wählen Sie Keymap aus den Einstellungen

4 - Suchen Sie in der oberen rechten Suchleiste nach "Fix Doc".

5 - Wählen Sie den "Fix Doc Kommentar" aus den Ergebnissen und doppelklicken Sie darauf

6 - Wählen Sie nach einem Doppelklick in der geöffneten Dropdown-Liste die Option Tastenkombination hinzufügen

7 - Drücken Sie die Tastenkombinationen auf der Tastatur

8 - Gehen Sie zu Ihrem Code und wo Sie einen Kommentar hinzufügen möchten, drücken Sie die Tastenkombination

9 - Viel Spaß!

Wählen Sie einfach die Eclipse-Version der Tastenkappe in den Keymap-Einstellungen aus. Eine Eclipse-Keymap ist in Android Studio enthalten.

Ich bin mir nicht sicher, ob ich die Frage vollständig verstehe, aber eine Liste der Tastaturkürzel finden Sie hier - Ich hoffe, das hilft!

Android Studio -> Einstellungen -> Editor -> Absichten -> Java -> Deklaration -> "JavaDoc hinzufügen" aktivieren

Wenn Sie links unten die zu implementierenden Methoden (Strg / Cmd + i) auswählen, sollte das Kontrollkästchen zum Aktivieren von JavaDoc kopieren angezeigt werden.

Ich empfahl Dokka für Geneate Javadoc mit Kommentar und mehr

ALT+ SHIFT+ Gerstellt die automatisch generierten Kommentare für Ihre Methode (platzieren Sie den Cursor an der Startposition Ihrer Methode).