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


15
Пример многострочного кода в комментарии Javadoc
У меня есть небольшой пример кода, который я хочу включить в комментарий 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 


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

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

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

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




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



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

Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.