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

Какой правильный термин для документации, которую мы поместили сразу над объявлением метода?
Я пишу технический документ и понял, что не уверен, каков официальный термин для внутренней документации, которую мы помещаем в блок комментариев перед объявлением определения. То же самое, что со временем становится документацией участника...
202 просмотров
schedule 21.02.2022

Как лучше всего использовать JavaDoc для документирования перечисления Java?
Я только начал использовать перечисления Java в своих собственных проектах (мне нужно использовать JDK 1.4 на работе), и я не понимаю, как лучше всего использовать JavaDoc для перечисления. Я обнаружил, что этот метод работает, но результирующий...
20551 просмотров
schedule 29.03.2023

Eclipse: прикрепить источник / javadoc к библиотеке через локальное свойство
У меня есть сторонняя библиотека в моем репозитории SVN, и я хотел бы связать источник / javadoc с ней локально в Eclipse. То есть должна быть какая-то локальная настройка (например, запись в файле local.properties ), которая связывает источник /...
29335 просмотров
schedule 10.04.2023

Реализация функции друга (доступной в C ++) в Java
Хорошо, давайте оставим дискуссию о том, разрушает ли дружба инкапсуляцию, и попробуем элегантно придумать целостный дизайн. Это двойная функция: 1) Общий вопрос, как реализовать: public class A { friend class B; } 2)...
343 просмотров
schedule 04.12.2022

Заставить javadoc игнорировать аннотацию
Я пытаюсь задокументировать аннотированный интерфейс и включить пример того, как он используется в javadoc. например /** * Here's an example usage: * * <PRE> * @IFaceAnnotation(value="") * public interface IFace { * *...
1997 просмотров
schedule 27.07.2023

javadoc только для package-info.java
У меня есть ситуация, когда я хотел бы выполнить javadoc в проекте, в котором нет классов. У него есть package-info.java только для одного пакета. При выполнении javadoc выдается следующая ошибка: An error has occurred in JavaDocs report...
5357 просмотров
schedule 18.04.2022

Как @связать значение Enum с помощью Javadoc
Используя Javadoc 1.5, мне не удалось создать @link для значения Enumeration. Я хотел бы создать Enum следующим образом: public enum Planet { /** * MERCURY is a fun place. */ MERCURY, /** * VENUS is more fun. */ VENUS, /** * But nothing...
43205 просмотров
schedule 12.03.2023

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

Плагин сайта maven не развертывает подпроекты в многомодульном проекте и не генерирует index.html
У меня есть многомодульный проект, для которого я хочу развернуть сайт, но похоже, что конфигурация развертывания моего сайта не наследуется дочерними модулями подпроекта. parent moduleA модульB В файловой системе они расположены...
2844 просмотров

Устареть в Java 1.6
В Java 1.5, чтобы объявить метод устаревшим, вы должны: @Deprecated int foo(int bar) { } Компиляция этого в Java 1.6 приводит к следующему: Синтаксическая ошибка, аннотации доступны только при уровне исходного кода 1.5. Любые идеи?
10626 просмотров
schedule 26.04.2023

Раздел «Использование Javadoc» — почему он отсутствует?
В javadocs некоторые API (вне java.lang и java.util ) "Использовать" отсутствует. Например, XMLStreamReader . Немного неприятно, что вы не можете сказать, какие классы API возвращают нужный вам класс, на основе javadoc, и вы должны...
589 просмотров
schedule 06.01.2023

Предупреждение об отсутствии пользовательских тегов javadoc
Мы создаем собственный Doclet для нашего проекта, чтобы создать конкретную документацию для нашего клиента. Мы определяем некоторые конкретные теги, которые анализируются доклетом при создании документации. Знаете ли вы, как попросить eclipse...
627 просмотров
schedule 09.11.2022

Как заставить работать наследование javadoc для внешних API? (с Мавен2)
Когда класс переопределяет конкретный метод или реализует и абстрактный метод, Javadoc автоматически наследуется, если явно не перезаписывается. Или, по крайней мере, инструмент пытается это сделать. Кажется, это не работает для связанных внешних...
2805 просмотров

Как правильно использовать javadoc:aggregate в многомодульном проекте maven?
Это мой родительский pom.xml файл (его часть) в многомодульном проекте: ... <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId>...
6401 просмотров
schedule 21.09.2022

расположение javadoc в Java ME?
Используя Eclipse 3.5 и плагин для mtj. Где я могу найти расположение Javadoc для Java ME? Как я могу установить местоположение Javadoc в Eclipse? Я использую motodev sdk, а также установил mtj в качестве плагинов Eclipse.
413 просмотров
schedule 23.10.2022

Javadoc-подобная документация для библиотек C/C++?
Существует ли такая вещь, как документация типа Javadoc, доступная для библиотек C/C++?
2115 просмотров
schedule 29.10.2023

Как получить значение {@docroot} в com.sun.javadoc.Taglet?
Я пишу собственный теглет для включения файла mathML в HTML-файл javadoc. Я хотел бы хранить все мои файлы *.mml в одной папке, возможно, в {@docroot}/doc-files папка. Мой вопрос: как я могу узнать значение строки @docRoot в объекте Taglet...
624 просмотров
schedule 19.12.2022

Как перестать писать установщики свойств Java для BlazeDS и JPA, которые мне не нужны?
BlazeDS не будет сериализовать свойство, если у него нет и геттера, и сеттера. Однако многие из моих свойств Java доступны только для чтения. Поэтому теперь мне нужно добавить сеттеры для поддержки процесса Unmarshalling. Если кто-либо из...
864 просмотров
schedule 17.06.2022

Как сгенерировать Javadoc из командной строки
Может ли кто-нибудь показать мне, как создать Javadoc из командной строки? Мой проект содержит пакет com.test , и я хочу поместить сгенерированную документацию в файлы, расположенные в определенной папке, например: C:/javadoc/test .
150642 просмотров
schedule 01.06.2024

Ascii на сокете TCP
Кто-нибудь может передать мне пример отправки сообщения Ascii через TCP? (Не удалось найти пример в сети) Спасибо, луч.
6964 просмотров
schedule 18.09.2022