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

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

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

155
Це питання 50/50. Ви також шукаєте єдині блоки javadoc для генерації javadoc по всьому документу. Що це таке?
додано Автор Karl Morrison, джерело
ALTR + ENTER показують перегляд, за допомогою якого можна створити коментар про вже оголошені методи.
додано Автор Zala Janaksinh, джерело
Можливо, вам слід додати до нього шаблон Live (налаштування Android - редактор - Live Templates - add). У текстовому полі шаблону додайте наступний текст./** * $ коментар $ * /
додано Автор Johnett Mathew, джерело

14 Відповіді

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

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

313
додано
Шкода, що це також не працює, щоб генерувати коментарі для класів, полів тощо.
додано Автор Ted Hopp, джерело
Звичайно, у нього є ярлик: позиція на ім'я методу/конструктора і натиснути alt + enter, вибрати generated javadoc з меню
додано Автор Ewoks, джерело

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

Приклад:

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

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

For more information check the link https://www.jetbrains.com/idea/features/javadoc.html

94
додано
Насправді в прикладі відсутній * перед останнім /
додано Автор Maximiliano Ambrosini, джерело
@satheeshwaran - насправді? Це така ж відповідь, як і у DouO (оригінальна відповідь), за винятком того, що він має приклад. Навіть посилання є копією. Наведений приклад повинен бути доданий до початкової відповіді.
додано Автор CJBS, джерело
@satheeshwaran - для чого це варто, я бачу, що просто бачити приклад коментарів (у відповіді) корисно, коли хтось хоче відповісти швидко ;-)
додано Автор CJBS, джерело
@Amey як щодо вже створених методів?
додано Автор Zala Janaksinh, джерело

Ось приклад коментаря 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. 
 * 
* 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; } }

Основний формат можна автоматично генерувати одним із наступних способів:

  • Position the cursor above the method and type /** + Enter
  • Position the cursor on the method name and press Alt + Enter > click Add JavaDoc enter image description here
24
додано

You can install JavaDoc plugin from Settings->Plugin->Browse repositories.

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

Документ додатка JavaDoc

enter image description here

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

You can use eclipse style of JavaDoc comment generation through "Fix doc comment". Open "Preference" -> "Keymap" and assign "Fix doc comment" action to a key that you want.

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.

Advantage is that, you can create comment block for all the methods at a time.

7
додано

In Android Studio you don't need the plug in. On A Mac just open Android Studio -> click Android Studio in the top bar -> click Prefrences -> find File and Code Templates in the list -> select includes -> build it and will be persistent in all your project

5
додано

ALT+SHIFT+G will create the auto generated comments for your method (place the cursor at starting position of your method).

4
додано
Він також не працює для мене. Можливо, він працює в спеціальній розкладці. Клавіатурну розкладку можна налаштувати в меню Параметри> Keymap. Або розкладка клавіатури була відредагована.
додано Автор Oliver Kranz, джерело
Це не працює для мене
додано Автор user2493476, джерело
public void hideKeyboard() u слід помістити курсор перед громадськістю та спробувати його або перевірити, чи у вас встановлено java doc у вашій студії.
додано Автор Dinesh IT, джерело

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

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

2
додано
  • Another way to add java docs comment is press : Ctrl + Shift + A >> show a popup >> type : Add javadocs >> Enter .

  • Ctrl + Shirt + A: Command look-up (autocomplete command name)

enter image description here

1
додано

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

  • Метод I:

Набравши/** і потім натиснувши Enter, ви можете створити наступну рядок коментарів, і вона автоматично генеруватиме параметри, і т.д.

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

1 - Перейти вгоруМеню

2 - File > Settings

3 - Виберіть Розподіл клавіатури з установок

4 - У верхньому правому рядку пошуку шукайте "Fix Doc"

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

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

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

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

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

1
додано

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

0
додано
Якщо я пригадую, цей ярлик працював лише, якщо у вас встановлено плагін "jautodoc".
додано Автор Matt, джерело
У eclipse додати javadoc коментарі натисніть Alt + shift + j, але в AndroidStudio, але я не знаю, як це зробити
додано Автор qinxianyuzou, джерело

Просто виберіть версію клавіші Eclipse у параметрах клавіатури. Eclipse Keymap входить до складу Android Studio.

0
додано

Android Studio -> Preferences -> Editor -> Intentions -> Java -> Declaration -> Enable "Add JavaDoc"

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

0
додано
ІТ КПІ - Java
ІТ КПІ - Java
436 учасників

android_jobs_ua
android_jobs_ua
120 учасників

Публикуем вакансии и запросы на поиск работы по направлению Android. Здесь всё: full-time, part-time, remote и разовые подработки.

Mobile Dev Jobs UA
Mobile Dev Jobs UA
20 учасників

Публикуем вакансии и запросы на поиск работы по направлению iOS, Android, Xamarin, RN и т.д.