Как создать комментарии Javadoc в Android Studio

Могу ли я использовать сочетания клавиш в Android Studio для создания комментариев Javadoc?

Если нет, то какой самый простой способ генерировать комментарии Javadoc?

Я не могу найти ярлык для создания комментариев Javadoc. Но если вы напечатаете /**перед объявлением метода и нажмете Enter, блок комментариев javadoc будет сгенерирован автоматически.

Прочитайте это для получения дополнительной информации.

Чтобы генерировать комментарии, введите /**ключ перед объявлением метода и нажмите Enter. Это будет генерировать комментарии Javadoc.

Пример:

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

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

Для получения дополнительной информации перейдите по ссылке https://www.jetbrains.com/idea/features/javadoc.html.

Вот пример комментария JavaDoc от 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;
        }
 }

Базовый формат может быть сгенерирован автоматически одним из следующих способов:

• Поместите курсор над методом и введите /**+Enter
• Поместите курсор на имя метода и нажмите Alt+ Enter> нажмите Добавить JavaDoc

Вы можете установить плагин JavaDoc из Настройки-> Плагин-> Обзор репозиториев.

получить документацию по плагину по ссылке ниже

Документ плагина JavaDoc

Вы можете использовать стиль затмения генерации комментариев JavaDoc через «Fix doc comment». Откройте «Preference» -> «Keymap» и назначьте действие «Fix doc comment» для нужной клавиши.

Здесь мы можем что-то вроде этого. И вместо использования любого ярлыка мы можем написать комментарии по умолчанию на уровне класса / пакета / проекта. И изменить согласно требованию

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

Преимущество в том, что вы можете создать блок комментариев для all the methods at a time.

Комментарии Javadoc могут автоматически добавляться с помощью функции автозаполнения IDE. Попробуйте набрать /**и нажать, Enterчтобы создать образец комментария 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
 */

В Android Studio вам не нужен плагин. На Mac просто откройте Android Studio -> нажмите Android Studio в верхней панели -> нажмите «Настройки» -> найдите шаблоны файлов и кодов в списке -> выберите «включает» -> создайте его и будет настойчивым во всем вашем проекте

• Еще один способ добавить комментарий к документации Java - это нажать: Ctrl + Shift + A >> показать всплывающее окно >> типа: Добавить javadocs >> Enter.

• Ctrl + Shirt + A: поиск команд (автозаполнение имени команды)

Просто выберите (т.е. щелкните) имя метода, затем используйте комбинацию клавиш Alt + Enter, выберите «Добавить JavaDoc»

Это предполагает, что вы еще не добавили комментарии над методом, иначе опция «Добавить JavaDoc» не появится.

В Android студии у нас есть несколько способов автоматически сгенерированных комментариев:

• Способ I:

Набрав / ** и затем нажав Enter, вы можете сгенерировать следующую строку комментария, и она автоматически сгенерирует параметры и т. Д., Но когда вам понадобится горячая клавиша для этого способа проверки II, описанного ниже.

• ** Метод II: **

1 - Перейти к верхнему меню

2 - Файл> Настройки

3 - Выберите Keymap из настроек

4 - В верхней правой строке поиска найдите «Fix Doc»

5 - Выберите «Fix Doc Comment» из результатов и дважды щелкните по нему.

6 - Выберите Добавить сочетание клавиш из раскрывающегося списка после двойного щелчка

7 - Нажмите сочетание клавиш на клавиатуре

8 - Перейдите в свой код и там, где вы хотите добавить комментарий, нажмите клавишу быстрого доступа

9 - Наслаждайтесь!

Просто выберите версию Eclipse keycap в настройках Keymap. Карта ключей Eclipse включена в Android Studio.

Я не уверен, что полностью понимаю вопрос, но список сочетаний клавиш можно найти здесь - надеюсь, это поможет!

Android Studio -> Настройки -> Редактор -> Намерения -> Java -> Объявление -> Включить «Добавить JavaDoc»

И, выбирая Методы для реализации (Ctrl / Cmd + i), в левом нижнем углу вы должны увидеть флажок, чтобы включить копирование JavaDoc.

я recommendated Докку для geneate Javadoc с комментариями и многими другими

ALT+ SHIFT+ Gсоздаст автоматически сгенерированные комментарии для вашего метода (поместите курсор в начальную позицию вашего метода).