Jak generować komentarze javadoc w Android Studio

To generatae comments type /** key before the method declaration and press Enter. Wygeneruje komentarz javadoc.

Przykład:

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

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

Aby uzyskać więcej informacji, sprawdź link https://www.jetbrains.com/idea/features/javadoc.html

Oto Przykład komentarza JavaDoc z 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;
        }
 }

Podstawowy format może być automatycznie wygenerowany w jeden z następujących sposobów:

• Umieść kursor nad metodą i wpisz /** + Enter
• Umieść kursor na nazwie metody i naciśnij Alt + Wpisz > kliknij Dodaj JavaDoc

Możesz zainstalować wtyczkę JavaDoc z menu Ustawienia - > Wtyczka - > Przeglądaj repozytoria.

Pobierz dokumentację wtyczki z poniższego linku

JavaDoc plugin document

Możesz użyć stylu eclipse generowania komentarzy JavaDoc poprzez "Fix Doc comment". Otwórz "Preference" - > "Keymap" i przypisz akcję "Fix Doc comment"do klucza, który chcesz.

Tutaj możemy zrobić coś takiego. I zamiast używać dowolnego skrótu możemy pisać" domyślne " komentarze na poziomie klasy / pakietu / projektu. I zmodyfikować zgodnie z wymaganiami

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

Zaletą jest to, że możesz utworzyć blok komentarzy dla all the methods at a time.

W Android Studio nie potrzebujesz wtyczki. Na komputerze Mac wystarczy otworzyć Android Studio - > kliknij Android Studio w górnym pasku - > kliknij Prefrences - > znajdź Szablony plików i kodu na liście -> wybierz zawiera - > zbuduj go i będzie trwały w całym projekcie

Po prostu wybierz (tzn. kliknij) nazwę metody, następnie użyj kombinacji klawiszy Alt + Enter, wybierz "Add JavaDoc"

Zakłada to, że nie dodałeś jeszcze komentarzy powyżej metody, w przeciwnym razie opcja "Dodaj JavaDoc" nie pojawi się.

• Innym sposobem na dodanie komentarza java docs jest naciśnięcie : Ctrl + Shift + a >> Pokaż wyskakujące okienko >> wpisz : Add javadocs >> Enter .

• Ctrl + Koszulka + A: wyszukiwanie poleceń (nazwa polecenia autouzupełniania)

W Android studio mamy kilka sposobów na automatyczne generowanie Komentarzy:

• Metoda I:

Wpisując / * * a następnie wciskając Enter możesz wygenerować następną linię komentarza, która automatycznie wygeneruje params, itp. ale kiedy potrzebujesz skrótu klawiszowego do tego Sprawdź metodę II poniżej.

• **metoda II: * *

1 - Goto topMenu

2-Plik > Ustawienia

3-Wybierz klawisz z ustawień

4-W prawym górnym pasku wyszukiwania Szukaj "Fix Doc"

5-Wybierz "popraw komentarz doc" z wyników i kliknij go dwukrotnie

6-Wybierz Dodaj skrót klawiaturowy z rozwijanej listy po dwukrotnym kliknięciu

7-Naciśnij klawisze skrótu na klawiaturze

8-przejdź do kodu i gdzie chcesz dodać komentarz naciśnij klawisz skrótu

9 - Enjoy!

Nie jestem pewien, czy do końca rozumiem pytanie, ale listę skrótów klawiszowych można znaleźć tutaj - Mam nadzieję, że to pomoże!

Wystarczy wybrać wersję Eclipse klawiatury w ustawieniach klawiatury. Mapa klawiatury Eclipse jest dołączona do Android Studio.

Android Studio -> Preferencje -> Edytor -> Intencje -> Java -> Deklaracja - > Włącz "Dodaj JavaDoc"

I podczas wybierania metod do zaimplementowania (Ctrl / Cmd + i), w lewym dolnym rogu powinieneś zobaczyć pole wyboru, aby włączyć kopiowanie JavaDoc.

Komentarze Javadoc mogą być automatycznie dodawane za pomocą funkcji autouzupełniania IDE. Spróbuj wpisać /** i nacisnąć Enter , Aby wygenerować przykładowy komentarz 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
 */

ALT+SHIFT+G utworzy automatycznie wygenerowane komentarze dla Twojej metody(Umieść kursor w pozycji początkowej metody).