Запитання з тегом «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")); * } …

531 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 …

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 додаються до конфігурації збірки зараз. На жаль, контейнер Classpath для Android Dependitions не змінюється. Як я можу приєднати javadoc та джерела до автоматично вставленого .jar (з папки / …

254 android  eclipse  adt  javadoc 

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

238 java  javadoc 

При спробі створити коментарі Javadoc на рівні пакету, що є кращим методом? Що ти робиш? package-info.java Плюси Новіші Мінуси Зловживання класом - Класи призначені для коду, а не лише для коментарів package.html Плюси Розширення HTML означає його не код Підсвічування синтаксису в редакторах IDE / тексту Мінуси Немає? Для мене …

230 java  javadoc 

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

204 android-studio  javadoc 

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

192 java  comments  javadoc 

Може хтось скаже мені різницю між javadoc @seeі {@link}? А точніше, коли використовувати який із них?

184 java  javadoc 

Я знаю, що це не найважливіша з питань, але я просто зрозумів, що можу поставити блок коментарів javadoc до або після анотації. Що б ми хотіли прийняти як стандарт кодування? /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired /** * This …

183 java  coding-style  annotations  javadoc  code-documentation 

У API Java я бачу коментарі Javadoc для пакетів. Як / де розміщувати коментарі Javadoc для документування пакету?

182 java  packages  javadoc 

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

180 java  escaping  javadoc 

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

176 eclipse  maven-2  javadoc