"35.172.217.40 - 35.172.217.40"

Как генерировать комментарии javadoc в Android Studio

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

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

+183
источник поделиться
16 ответов

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

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

+357
источник

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

Пример:

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

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

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

+105
источник

Вот пример комментария 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 enter image description here
+33
источник

Вы можете установить плагин JavaDoc из настроек- > Plugin- > Browse repositories.

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

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

введите описание изображения здесь

+16
источник

Вы можете использовать стиль eclipse для генерации комментариев JavaDoc через "Fix doc comment". Откройте "Предпочтения" → "Ключ карты" и назначьте действие "Fix doc comment" на требуемый ключ.

+10
источник

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

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

+8
источник

Комментарии 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
 */
+7
источник

В Android Studio вам не нужен плагин. На Mac просто откройте Android Studio → щелкните Android Studio в верхней строке → нажмите Prefrences → найдите в списке список файлов и кодов → выберите → постройте его и будете настойчивы во всем своем проекте

+5
источник

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

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

+2
источник

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

  • Метод I:

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

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

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

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

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

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

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

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

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

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

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

+2
источник

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

+1
источник
  • Другой способ добавления комментария javas docs - нажать: Ctrl + Shift + A → показать всплывающее → тип: Добавить javadocs → Enter.

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

введите описание изображения здесь

+1
источник

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

0
источник

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

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

0
источник

я рекомендовал Dokka для создания Javadoc с комментариями и многое другое

0
источник

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

-4
источник

Посмотрите другие вопросы по меткам или Задайте вопрос