Як генерувати коментарі javadoc в Android Studio


204

Чи можна використовувати клавіші швидкого доступу в студії Android для створення коментарів javadoc?

Якщо ні, то який найпростіший спосіб генерувати коментарі javadoc?


Це питання - 50/50. Ви шукаєте поодинокі блоки javadoc для генерації Javadoc у всьому документі. Що це таке?
K - Токсичність в SO зростає.

ALTR + ENTER показує подання, ви можете генерувати коментар уже оголошених методів.
Zala Janaksinh

Можливо, ви повинні додати для нього шаблон "Живий" (Android студія - налаштування - редактор - Живі шаблони - додати). У текстове поле шаблону додайте наступний текст. / ** * $ коментар $ * /
Джоннет Меттью

Відповіді:


388

Я не можу знайти жодного ярлика для створення коментарів javadoc. Але якщо ввести /**перед оголошенням методу і натиснути Enter, блок коментарів javadoc буде генерований автоматично.

Прочитайте це для отримання додаткової інформації.


7
Прикро, що це також не працює для створення коментарів javadoc для класів, полів тощо. Було б навіть приємніше, якби він генерував javadoc з настроюваного шаблону.
Тед Хопп

23
звичайно, у ньому є ярлик: позиція на ім'я методу / конструктора та натисніть клавішу alt + enter, виберіть з меню створення генерувати javadoc
Ewoks

зверніться до цього детальніше про вищезазначене рішення
Pritesh

110

Щоб створити коментарі, введіть /**клавішу перед оголошенням методу та натисніть Enter. Це породжує коментар javadoc.

Приклад:

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

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

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


4
@satheeshwaran - справді? Це та сама відповідь, що і відповідь DouO (оригінальна відповідь), за винятком того, що вона має приклад. Навіть посилання - це копія. Приклад повинен був лише бути доданий до початкової відповіді.
CJBS

3
@satheeshwaran - для чого це варто, я можу побачити, що просто побачити приклад коментарів (у відповіді) корисно, коли потрібно швидко відповісти ;-)
CJBS

Насправді прикладу не вистачає * до останнього /
Максиміліано Амброзіні,

35

Ось приклад коментаря 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 введіть тут опис зображення

17

Ви можете встановити плагін JavaDoc з Налаштування-> Плагін-> Огляд сховищ.

отримати документацію на плагін за посиланням нижче

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

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


Це чудово працює. Встановіть плагін JavaDoc (як вище), а потім натисніть CNTL + SHIFT + ALT + G.
Алан Нельсон

10

Ви можете використовувати стиль затемнення JavaDoc-генерації коментарів через "Виправити коментар до документа". Відкрийте "Налаштування" -> "Клавіатура" та призначте дію "Виправити коментар до документа" потрібному ключу.


9

Тут ми можемо щось подібне. І замість того, щоб використовувати будь-який ярлик, ми можемо писати коментарі за замовчуванням на рівні класу / пакету / проекту. І змінювати відповідно до вимог

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


9

Коментарі 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
 */

5

В Android Studio вам не потрібен плагін. На Mac просто відкрийте Android Studio -> натисніть Android Studio у верхній панелі -> натисніть Prefrences -> знайдіть у списку шаблони файлів та коду -> select include -> build it і буде наполегливим у всьому вашому проекті


2
  • Ще один спосіб додати коментарі до документів Java - натиснути: Ctrl + Shift + A >> показати спливаюче вікно >> тип: Додати javadocs >> Enter.

  • Ctrl + Shirt + A: Пошук команд (автозавершене ім'я команди)

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


2

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

Це передбачає, що ви вже не додавали коментарів вище методу, інакше опція "Додати JavaDoc" не з’явиться.


2

У студії Android у нас є кілька способів автоматичного створення коментарів:

  • Спосіб I:

Ввівши / **, а потім натиснувши Enter, ви зможете генерувати наступний рядок коментарів, і він автоматично генерує параметри тощо, але коли вам знадобиться гаряча клавіша для цього способу перевірки II нижче.

  • ** Спосіб II: **

1 - Перейти до topMenu

2 - Файл> Установки

3 - Виберіть Keymap із налаштувань

4 - У верхньому правому куті пошуку пошуку "Виправити документ"

5 - Виберіть "результати виправити коментар док" з результатів та двічі клацніть на ньому

6 - Виберіть команду Додати ярлик клавіатури із відкритого списку після подвійного клацання

7 - Натисніть клавіші швидкого доступу на клавіатурі

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

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


Найзручніший спосіб додати документи. Наприклад, я призначив "" "та введіть як ярлик
CodeToLife

1

Просто виберіть у налаштуваннях Keymap версію Eclipse keycap. Клавіатура Eclipse включена в Android Studio.


0

Я не впевнений, що повністю розумію питання, але тут можна знайти список скорочень клавіатур - Сподіваюся, це допомагає!


2
У затемненні, щоб додати коментарі до javadoc, натисніть Alt + shift + j, але в AndroidStudio, але я не знаю, як це зробити
qinxianyuzou

Якщо я пам'ятаю, ця комбінація клавіш працювала лише в тому випадку, якщо у вас був встановлений і включений плагін "jautodoc".
Метт

0

Android Studio -> Налаштування -> Редактор -> Намір -> Java -> Декларація -> Увімкнути "Додати JavaDoc"

І, вибираючи Методи реалізації (Ctrl / Cmd + i), у лівій нижній частині ви повинні побачити прапорець, щоб увімкнути Копіювати JavaDoc.



-5

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


public void hidKeyboard () u повинен розмістити курсор перед загальнодоступним та спробувати його чи будь ласка, перевірте, чи встановлено u java doc у вашій студії.
Дінеш ІТ

Не працює і для мене. Можливо, він працює в якійсь спеціальній мапі. Мапа клавіш може бути налаштована в Налаштуваннях> Клавіатура. Або клавішу відредаговано.
Олівер Кранц
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.