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

Измерение охвата документации с помощью Javadoc и Ant
Я участвую в проекте, в котором общедоступная документация по API является четким результатом. Чтобы убедиться, что выпуск соответствует этому требованию, я хотел бы гарантировать, что цель выпуска в моем файле сборки Ant не будет работать, если...
2298 просмотров
java javadoc ant
schedule 06.06.2022
Eclipse - @SuppressWarnings (javadoc) не работает
Мой Eclipse настроен на отображение предупреждений об отсутствующих комментариях и тегах javadoc для общедоступных элементов. Это очень полезно для меня, чтобы мой код был хорошо документирован. Но иногда у меня есть класс, где у меня есть...
6102 просмотров
eclipse compiler-warnings warnings javadoc suppress-warnings
schedule 10.08.2023
Как автоматически генерировать комментарии для получателя / установщика на основе комментариев поля в Eclipse?
Я хочу, чтобы Eclipse автоматически генерировал комментарии Javadoc для моих методов получения и установки на основе ранее определенных комментариев для полей. Как я могу этого добиться? Предыстория: политика нашей компании заключается в том,...
28246 просмотров
java eclipse javadoc
schedule 21.03.2022
Есть ли способ сгенерировать вики-страницы слияния из javadocs?
Я хотел бы разместить документацию на вики-странице слияния для проекта, над которым я работаю, и я хочу автоматически генерировать часть документации из javadocs. Есть ли плагин для слияния, который упрощает это (не видел при предварительном...
7371 просмотров
wiki confluence javadoc
schedule 05.02.2024
Как установить путь javadoc для jar-файла в проекте с помощью Eclipse
Я использую JUnit 3 в Eclipse Galileo. junit.jar (находится в проекте в vendor/lib/ ) содержит классы и javadoc. В моем проекте, которым я делюсь с помощью CVS, я хочу, чтобы документ был доступен всем, кто проверяет проект. Итак, я зафиксировал...
2474 просмотров
eclipse jar classpath javadoc
schedule 26.03.2022
Есть ли в Javadoc эквивалент ‹![CDATA[ ]]›?
К сожалению, в HTML нет CDATA. Жаль, потому что это было бы идеально для добавления javadoc комментариев, включающих XML, поэтому вам не нужно экранировать символы ‹ и >, например: /**<![CDATA[ This parses <complexType name="">...
6969 просмотров
java xml html javadoc cdata
schedule 30.12.2023
Создайте Javadoc для моего проекта Android
я надеялся, что кто-то может помочь мне в создании javadoc для моего проекта eclipse. Когда я выбираю «Создать Javadoc» в меню проекта, я получаю много ошибок, таких как cannot find symbol symbol : class ListView каждый раз, когда класс...
25756 просмотров
android java javadoc
schedule 12.09.2022
Как заставить Eclipse показывать Javadoc для аннотаций javax
Мне очень нравится, как в Eclipse есть всплывающая документация Javadoc для различных классов библиотеки Java, которые я использую. Однако я также использую аннотации JPA и JAXB, такие как @Entity и @XMLType. Eclipse распознает их как...
2594 просмотров
annotations javadoc
schedule 26.06.2023
Отметка использования примера в документации по коду
Как лучше всего размещать примеры использования в документации по коду? Есть ли стандартный способ? С @usage или @notes? Поддерживают ли генераторы документов это? Я знаю, что этот вопрос должен зависеть от генератора документации. Тем не...
1720 просмотров
documentation javadoc documentation-generation doxygen
schedule 30.03.2022
Как weakCompareAndSet может ложно потерпеть неудачу, если он реализован точно так же, как compareAndSet?
(обратите внимание, что этот вопрос не о CAS, а о "Может произойти ложный сбой" Javadoc). Единственная разница в Javadoc между этими двумя методами из класса AtomicInteger состоит в том, что weakCompareAndSet содержит комментарий: "Может...
8115 просмотров
java concurrency javadoc
schedule 30.05.2024
scaladoc Написание задачи Ant для нескольких исходных каталогов?
Я хочу скомпилировать scaladoc и javadoc в проекте, в котором есть как scala, так и java. В проекте есть несколько исходных каталогов (каждый из которых может иметь scala или javadoc). Я пытался: <scaladoc destdir="doc">...
741 просмотров
scala javadoc ant scaladoc
schedule 31.05.2022
Автоматическая публикация javadoc при создании проекта maven с помощью hudson
Я использую Hudson для создания проектов Maven с выделенной работой Maven 2. к сожалению, я не могу найти способ опубликовать сгенерированный javadoc, как это можно сделать с помощью задания «Свободный стиль» и опции «Опубликовать javadoc». Запуск...
5194 просмотров
maven-2 javadoc hudson
schedule 24.07.2022
Документирование геттеров и сеттеров
Для простых геттеров / сеттеров, подобных приведенному ниже, как лучше всего это задокументировать? public float getPrice() { return price; } Я довольно строго отношусь к стандартам кодирования, поэтому моя IDE предупреждает меня о любых...
3824 просмотров
documentation coding-style javadoc language-agnostic
schedule 01.03.2022
Есть ли более простой способ указать URL-адреса javadoc в intellij?
У меня есть несколько модулей в проекте IntelliJ, где зависимости каждого модуля управляются ivy. Моя проблема в том, что для каждого отдельного модуля я должен указать URL-адрес javadoc общих сторонних библиотек с помощью этих утомительных...
813 просмотров
java intellij-idea ivy javadoc
schedule 18.01.2024
Развернуть встроенные теги в пользовательском теглете Javadoc
Я написал собственный тег Javadoc, который добавляет новый тег note : ... public boolean isInlineTag() { return false; } public String toString(Tag tag) { return "<pre class='note'>" + tag.text() + "</pre>"; } Пока...
1958 просмотров
java javadoc custom-tag taglet
schedule 01.06.2022
Куда следует обращаться с комментариями и аннотациями к методам?
Итак, допустим, у меня есть метод, содержащий такую ​​аннотацию: @Override public void bar(String x) Если бы я добавил к этому фрагменту кода комментарии Javadoc, какой метод был бы предпочтительнее? Либо: /** * @param x A string...
4298 просмотров
java comments javadoc
schedule 16.05.2022
Как добавить документацию Java API в Eclipse?
Я скачал документацию по API Java с сайта http://www.oracle.com/technetwork/java/javase/downloads/index.html#docs и предположительно подключили его к Eclipse, используя Окно->Настройки->Java->Установленные JRE->Правка->"Выбрать...
161853 просмотров
java eclipse javadoc
schedule 08.04.2022
Как добавить javadocs в сборку Maven на Hudson
Я использую Hudson 1.389 и Maven 2 и создаю javadocs как часть моей сборки. Javadocs создаются для: target/apidocs. Однако на них нет ссылки со страницы проекта Hudson (или страницы модуля). Мой проект представляет собой многомодульный проект...
2422 просмотров
maven-2 javadoc hudson
schedule 17.04.2024
Пустой шаблон для файла Javadoc на уровне пакета
Страница Oracle " Как писать комментарии к документам для инструмента Javadoc Tool "содержит ссылку на" пустой шаблон для файла комментариев документа на уровне пакета ", который не показывает ожидаемое содержимое базового файла package.html. Я...
1866 просмотров
java javadoc
schedule 03.03.2024
Как я могу создать файл jar, чтобы пользователи, использующие библиотеку, могли видеть javadoc в Eclipse
Я работаю над небольшой библиотекой для использования внутри компании и тщательно ее документирую. Теперь я создаю свою банку со следующим кодом: <project name="commonutils" default="compile" basedir="."> <property name="src"...
575 просмотров
java javadoc ant javac
schedule 25.12.2022