Вопросы с тегом 'javadoc'

Javadoc - это расширяемая система генерации документации, которая читает специально отформатированные комментарии в исходном коде Java и генерирует скомпилированную документацию. Он обычно используется для создания документации API в виде веб-страниц HTML.
3

Как ссылаться на метод в javadoc?

Как я могу использовать тег @link для ссылки на метод? Я хочу изменить /** * Returns the Baz object owned by the Bar object owned by Foo owned by this. * A convenience method, equivalent to getFoo().getBar().getBaz() * @return baz */ public Ba...
06 мая '11 в 19:15
5

Ссылка на внешний URL-адрес в Javadoc?

Что-то вроде: /** * See {@linktourl http://google.com} */
04 июл. '09 в 11:44
13

Пример нескольких строк кода в комментарии Javadoc

У меня есть небольшой пример кода, который я хочу включить в комментарий Javadoc для метода. /** * -- ex: looping through List of Map objects -- * <code> * for (int i = 0; i < list.size(); i++) { * Map map = (Map)list.get(i); * ...
12 февр. '09 в 15:52
11

Как увидеть JavaDoc в IntelliJ IDEA?

Я только что переключился с Eclipse на IntelliJ. В IntelliJ отсутствует одна особенность Eclipse - когда вы наводите указатель мыши на метод, Eclipse отображает информацию javadoc. Я думаю, что способ показать это - использовать ярлык - command + J,...
15 июн. '12 в 14:56
18

Maven не работает на Java 8, когда теги Javadoc являются неполными

Поскольку я использую Maven, мне удалось создать и установить в моих проектах локального репозитория, которые имеют неполные теги Javadoc (например, отсутствующий параметр). Однако, поскольку я перешел на Java 8 (1.8.0-ea-b90), Maven абсолютно строг...
08 апр. '13 в 18:23
12

Как подключить javadoc или источники к банкам в папке libs?

Новая версия плагина ADT r17 для функции добавления Eclipse для автоматической настройки зависимостей JAR. Любые файлы .jar в папке /libs теперь добавляются в конфигурацию сборки. К сожалению, контейнер для классов Android Dependencies не модифициру...
26 мар. '12 в 13:35
4

Как добавить ссылку на параметр метода в javadoc?

Есть ли способ добавить ссылки на один или несколько параметров метода из тела документации метода? Что-то вроде: /** * When {@paramref a} is null, we rely on b for the discombobulation. * * @param a this is one of the parameters * @param b anot...
03 нояб. '09 в 13:00
1

Javadoc: package.html или package-info.java

При попытке создать комментарии Javadoc на уровне пакетов, какой предпочтительный метод? Что вы делаете? package-info.java Pros Новые Cons Злоупотребление классом - Классы предназначены для кода, а не только для комментариев package.htm...
05 сент. '10 в 2:02
5

Как я могу генерировать комментарии Javadoc в Eclipse?

Возможный дубликат: Генератор шаблонов Javadoc Есть ли способ генерировать комментарии Javadoc в Eclipse? Если да, то что это такое?
21 нояб. '09 в 23:44
16

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

Могу ли я использовать сочетания клавиш в студии Android для создания комментариев javadoc? Если нет, то какой самый простой способ генерировать комментарии javadoc?
25 июн. '13 в 7:42
3

Как упаковать документы на Java?

В Java API я могу видеть комментарии Javadoc для пакетов. Как/где разместить комментарии Javadoc для документирования пакета?
08 мар. '09 в 22:17
5

codestyle; поставить javadoc до или после аннотации?

Я знаю, что это не самая важная проблема, но я просто понял, что могу поставить блок комментариев javadoc до или после аннотации. Что мы хотим принять в качестве стандарта кодирования? /** * This is a javadoc comment before the annotation */ @Com...
24 июн. '10 в 12:35
17

Получите исходные файлы jar, прикрепленные к Eclipse для зависимых от Maven зависимостей

Я использую Maven (и Maven Eclipse Integration) для управления зависимостями для моих проектов Java в Eclipse. Функция автоматической загрузки файлов JAR из репозиториев Maven - это экономия в реальном времени. К сожалению, он не включает документаци...
22 нояб. '08 в 1:53
4

Как вы можете избежать символа @в javadoc?

Как я могу избежать символа @ в javadoc? Я пытаюсь использовать его внутри тега {@code}, который находится внутри тегов <pre>. Я уже пробовал последовательность html escape &#64;, но это не сработало.
18 февр. '10 в 17:34
8

Технические советы для написания замечательного Javadoc

Каковы ваши технические советы для написания отличного Javadoc? Я ищу вещи, выходящие за рамки стандартных советов по теме "Объяснение функции". Мы все это знаем! (Правильно?) Мне интересны такие вещи: Какие теги должны определенно быть частью...
29 дек. '09 в 20:16