Вопросы с тегом «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 Baz fooBarBaz() чтобы: /** * Returns the Baz object …

864 java  hyperlink  javadoc 

Что-то вроде: /** * See {@linktourl http://google.com} */

768 java  url  javadoc  hyperlink 

У меня есть небольшой пример кода, который я хочу включить в комментарий Javadoc для метода. /** * -- ex: looping through List of Map objects -- * <code> * for (int i = 0; i < list.size(); i++) { * Map map = (Map)list.get(i); * System.out.println(map.get("wordID")); * System.out.println(map.get("word")); * } …

532 java  html  javadoc 

Есть ли способ добавить ссылки на один или несколько параметров метода из тела документации метода? Что-то вроде: /** * When {@paramref a} is null, we rely on b for the discombobulation. * * @param a this is one of the parameters * @param b another param */ void foo(String a, …

313 java  arguments  javadoc 

Так как я использую Maven, я могу создавать и устанавливать в своих проектах локального репозитория, которые имеют неполные теги Javadoc (например, отсутствующий параметр). Однако, поскольку я перешел на Java 8 (1.8.0-ea-b90), Maven абсолютно строго относится к отсутствующим тегам документации и показывает мне множество ошибок Javadoc, связанных с проблемами Javadoc, когда …

312 java  maven  migration  java-8  javadoc 

В новой версии плагина ADT r17 для Eclipse добавлена ​​функция автоматической настройки зависимостей JAR. Любые файлы .jar в папке / libs будут добавлены в конфигурацию сборки. К сожалению, контейнер пути класса Android Dependencies не подлежит изменению. Как я могу прикрепить Javadoc и источники к автоматически вставленному .jar (из папки / …

254 android  eclipse  adt  javadoc 

В настоящее время я ссылаюсь на методы в других классах с этим синтаксисом Javadoc: @see {@link com.my.package.Class#method()} И в том, что я понимаю из документации, это правильный способ сделать это. Но теперь самое смешное или неприятное. Когда я генерирую этот javadoc, я в первую очередь получаю следующую ошибку: warning - …

238 java  javadoc 

При попытке создать комментарии на уровне пакета Javadoc, какой метод предпочтительнее? Чем ты занимаешься? package-info.java Pros Новее Cons Злоупотребление классом - классы для кода, а не только для комментариев package.html Pros Расширение HTML означает, что это не код Подсветка синтаксиса в IDE / текстовых редакторах Cons Никто? Для меня я …

230 java  javadoc 

Могу ли я использовать сочетания клавиш в Android Studio для создания комментариев Javadoc? Если нет, то какой самый простой способ генерировать комментарии Javadoc?

204 android-studio  javadoc 

какая разница между /** * comment * * */ и /* * * comment * */ на Яве? Когда я должен их использовать?

192 java  comments  javadoc 

Может кто-нибудь сказать мне разницу между Javadoc @seeи {@link}? Вернее, когда использовать какой из них?

184 java  javadoc 

Я знаю, что это не самая насущная проблема, но я только что понял, что могу поставить блок комментариев Javadoc до или после аннотации. Что бы мы хотели принять в качестве стандарта кодирования? /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired /** …

184 java  coding-style  annotations  javadoc  code-documentation 

В API Java я вижу комментарии Javadoc для пакетов. Как / где я могу разместить комментарии Javadoc для документирования пакета?

182 java  packages  javadoc 

Как я могу избежать @символа в Javadoc? Я пытаюсь использовать его внутри {@code}тега, который находится внутри <pre>тегов. Я уже пробовал html escape- @последовательность, но это не сработало.

180 java  escaping  javadoc 

Я использую Maven (и Maven Eclipse Integration) для управления зависимостями для моих Java-проектов в Eclipse. Функция автоматической загрузки файлов JAR из репозиториев Maven позволяет сэкономить время. К сожалению, он не включает документацию по API и исходный код. Как настроить Maven на автоматическое получение исходных файлов и вложений javadoc и их …

176 eclipse  maven-2  javadoc