Как сгенерировать javadoc android studio

Как создать JavaDoc с помощью Android Studio без R и BuildConfig?

Я хочу создать JavaDoc для своей библиотеки, исключая R и BuildConfig. Функциональность Generate JavaDoc. из меню Tools не имеет возможности исключать файлы.

Как создать JavaDoc с помощью Android Studio без R и BuildConfig?

4 ответа

Ответ RocketSpock почти готов, но не совсем (на момент написания этой статьи). Я пока не могу комментировать, поэтому опишу процесс, который я использовал для исключения R.java и BuildConfig.java из документации Javadoc моей библиотеки Android в Android Studio 1.2.2. По сути, есть дополнительный диалог, который очень пригодится:

Откройте опцию меню Tools —> Javadoc .

Выберите Custom scope . Необязательно ничего выбирать из выпадающего меню пока нет.

Щелкните значок . , чтобы открыть диалоговое окно Scopes .

Добавьте новую настраиваемую область с зеленым значком + . Дайте ему описательное имя, если хотите.

В Production Classes (не Library Classes , поскольку они import) перейдите к модулям, для которых вы хотите создать документацию Javadoc, и выберите любые отдельные файлы Java, которые вы хотите включить. В вашем случае вы, вероятно, захотите выбрать весь модуль, но вручную исключить R.java и BuildConfig.java . Когда вы закончите, нажмите OK , чтобы закрыть диалоговое окно «Области».

В диалоговом окне Specify Generate JavaDoc scope , если ваша новая область видимости не выбран в раскрывающемся меню Custom scope , выберите его сейчас, как а также любые другие дополнительные параметры, включая каталог вывода.

Наконец, нажмите OK , чтобы создать документ Javadoc.

Другой способ сделать это — 1 — перейти в Инструменты -> Создать JavaDoc . 2 — выбрать Пользовательский объем 3 — в раскрывающемся меню выбрать «Открыть файлы».

Этот метод сгенерирует документацию только для открытых файлов в вашем окне

Если вы хотите исключить сгенерированные файлы (R, BuildConfig и т. Д.), Вы можете указать настраиваемую область для создания JavaDoc. Для корректной работы вам потребуется:

1. В представлении «Проект» слева выберите корневой исходный каталог, для которого будут созданы документы (например, «com» ​​или «org»).
2. Откройте диалоговое окно создания JavaDoc (Инструменты -> Создать JavaDoc . )
3. Выберите «Пользовательская область видимости» (это пятый переключатель в моей версии) и выберите свой модуль (например, «Библиотека модуля»).
4. Выберите другие свойства, такие как каталог вывода, видимость метода и т. Д., И нажмите «ОК».

Вот и все. Ваши JavaDocs должны быть созданы без включенных файлов R или BuildConfig.

Принятый ответ довольно сложен, и у меня есть лучший.

1. Откройте пункт меню Инструменты -> Javadoc.
2. Выберите Custom scope. Затем выберите Project Files
3. Нажмите OK .

После этого вы увидите, что файлы R и BuildConfig исключены.

Источник

Как создать JavaDoc с помощью Android Studio без R и BuildConfig?

Я хочу создать JavaDoc для моей библиотеки, исключая R и BuildConfig. Функция Generate JavaDoc. из меню « Tools не имеет возможности исключать файлы.

Как создать JavaDoc с помощью Android Studio без R и и BuildConfig?

Ответ RocketSpock почти есть, но не совсем (на момент написания этой статьи). Я еще не могу прокомментировать, поэтому я опишу процесс, который я использовал, чтобы исключить R.java и BuildConfig.java из Javadoc в Android-платформе Android 1.2.2. В основном есть дополнительный диалог, который будет очень полезен:

Откройте пункт меню Tools —> Javadoc .

Выберите « Custom scope . Нет необходимости выбирать что-либо из раскрывающегося меню.

Нажмите значок . чтобы открыть диалоговое окно « Scopes ».

Добавьте новую настраиваемую область с помощью значка «зеленый + . Дайте ему описательное имя, если хотите.

В Production Classes (а не в Library Classes , поскольку они являются импортом) перейдите к модулю (модулям), для которого вы хотите создать Javadoc, и выберите любые отдельные файлы Java, которые вы хотите включить. В вашем случае вы, вероятно, захотите выбрать весь модуль, но вручную исключить R.java и BuildConfig.java . Когда вы закончите, нажмите « OK чтобы выйти из диалогового окна «Области».

В диалоговом окне « Specify Generate JavaDoc scope », если ваша новая область не выбрана в раскрывающемся меню « Custom scope , выберите ее сейчас, а также любые другие дополнительные параметры, включая выходную директорию.

Наконец, нажмите « OK чтобы создать свой Javadoc.

Принятый ответ довольно сложный, и у меня есть лучший.

1. Откройте пункт меню Инструменты -> Javadoc.
2. Выберите «Пользовательская область». Затем выберите « Project Files
3. Нажмите « OK .

После этого вы увидите, что файлы R и BuildConfig исключены.

Если вы хотите исключить сгенерированные файлы (R, BuildConfig и т. Д.), Вы можете указать настраиваемую область для генерации JavaDoc. Для правильной работы вам необходимо:

1. В представлении «Проект» слева выберите корневой исходный каталог для создания документов для (например, «com» ​​или «org»)
2. Откройте диалог генерации JavaDoc (Tools -> Generate JavaDoc …)
3. Выберите «Пользовательская область» (это пятый переключатель в моей версии) и выберите ваш модуль (например, «Библиотека модуля»)
4. Выберите другие свойства, такие как каталог вывода, видимость метода и т. Д. И нажмите «ОК»

Вот и все. Ваши JavaDocs должны быть сгенерированы без включенных файлов R или BuildConfig.

Источник

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

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

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

15 ответов

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

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

В generatae комментарии типа /** клавиша перед объявлением метода и нажмите Enter . Это generage комментария javadoc.

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

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

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

вы можете установить плагин JavaDoc из настроек — > плагин — >обзор репозиториев.

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

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

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

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

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

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

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

другой способ добавить комментарий к java docs-нажать:Ctrl + Shift + A > > показать всплывающее окно > > тип: добавить javadocs > > Enter .

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

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

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

1 — Гото topMenu

2 — Файл > Параметры

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

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

5-Выберите «fix doc comment» из результатов и дважды щелкните по нему

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

7-Нажмите клавиши быстрого доступа на клавиатуре

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

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

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

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

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

комментарии Javadoc могут быть автоматически добавлены с помощью функции автозаполнения IDE. Попробуйте ввести /** и наезд Enter для создания примера комментария Javadoc.

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

Источник

создать JavaDocs Android Studio

Есть ли какой-нибудь способ сгенерировать JavaDoc в Android Studio аналогично тому, как это делается в Eclipse, где я просто иду в Project —> Generate Java Docs ? Я имею в виду экспортировать его как HTML страницу. Я не могу найти подобный вариант в Android Studio, я искал несколько сообщений и не могу найти ответа.

1 ответ

Можно ли создать javadocs в стиле android для моего проекта android (например, http://developer.android.com/reference/java/lang/String.html , а не https://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html ) Это что-то связанное с использованием какого-то пользовательского доклета вместо.

Комната звучит интересно , но я не могу найти ни одного из классов на сайте разработчика Android JavaDocs , так как они не отображаются при поиске. Есть ли JavaDocs свободных номеров?

Когда проект открыт, перейдите в меню Инструменты > Создать JavaDoc .

Похожие вопросы:

Как заставить Android Studio показывать JavaDocs при наведении курсора мыши на метод? Я запускаю Android Studio и включил Show quick doc on mouse move . Однако, когда я навожу курсор на метод, он.

Я хочу создать теги @CreationDate и @ModifiedDate JavaDoc, чтобы упомянуть даты в JavaDocs. Например /** * It’s a custom exception specially designed for some critical events. * This is related to.

Есть ли простой способ создать страницы документации на основе документации xml в visual studio 2010/c#, как это делается в ecplipse/java javadocs?

Можно ли создать javadocs в стиле android для моего проекта android (например, http://developer.android.com/reference/java/lang/String.html , а не.

Комната звучит интересно , но я не могу найти ни одного из классов на сайте разработчика Android JavaDocs , так как они не отображаются при поиске. Есть ли JavaDocs свободных номеров?

Как я могу сгенерировать JavaDocs для проекта Android с помощью новой системы сборки Gradle? Вот что я придумал, но это не работает. task generateJavadoc(type: Javadoc) < source =.

Я не могу создать javadocs в папку, которая мне нравится, вот как выглядит мой плагин javadoc;

Мне нужен ярлык для capitalize (измените первую букву каждого слова на верхний регистр) в Android studio. Я знаю, что ярлык Toggle Case -это Ctrl + Shift + U ( Command + Shift + U на Mac) в Android.

Я начал Android studio (2.1.2) сегодня , и при попытке добавить комментарии блока с помощью /** + enter он не генерирует весь блок с помощью params и оператора return. Я не уверен, что является.

Android Studio 3.2. Я создаю 2 эмулятора по Android Studio. Ницца. Но вопрос в том: Можно ли создать android emulator без Android Studio? Наши QA должны использовать эмуляторы для тестирования наших.

Источник

Android студия / Gradle Javadoc задача

Тем не менее, я заметил, что создание Javadoc с помощью графического интерфейса Android Studio (меню «Инструменты») работает просто отлично — разрешаются зависимости от других библиотек и т. Д. Так как же это работает — разве это меню не использует задачу gradle для создания Javadoc?

Поскольку мне нужно сгенерировать Javadoc с использованием gradle как части CI, меня очень расстраивает отсутствие документированного способа заставить его работать, хотя есть способ, который работает через меню. Разве в меню Инструменты -> Создать Javadoc в Android Studio не используется задача градиента? Поскольку зависимости перечислены в файлах Gradle, а меню инструментов Javadoc, по-видимому, способно разрешить эти зависимости — как это реализовано? Каким образом он получает jar-файлы, встроенные в зависимые библиотеки aar и т. Д.? Как его можно использовать автономно, а не через графический интерфейс Android Studio?

3 ответа

Может быть, у вас есть решение этого. На всякий случай, ниже, как я генерирую документацию API для моего Jenkins CI.

Затем запустите команды gradle, чтобы получить ваш API вместо «$buildDir/docs» .

Изменить для Gradle Plugin 3.4.1

Инструмент для генерации документации в стиле Java называется javadoc и устанавливается в каждый JDK. Вы можете настроить, какие классы или пакеты вы хотите включить, какие из них следует исключить и многие другие параметры. Введите javadoc в терминале, где доступен JDK, и вы получите представление. См. Также https: //docs.oracle.com/javase/9/javadoc/javadoc.htm#JSJAV-GUID-7A344353-3BBF-45C4-8B28-15025DDCC643

После того, как вы доберетесь до оптимальной конфигурации, вы можете включить шаг Javadoc в свой CI.

Я использую задачу gradle, которая просто выполняет файл сценария bash с помощью одной (довольно длинной) команды javadoc.

Что вы можете сделать, это запустить генерацию Javadoc из Android Studio один раз, затем скопировать выполненную команду javadoc из журнала Studio со всеми правильными параметрами и автоматизировать выполнение той же команды в своем приложении.

Источник