Открытый редактор JavaDoc

Question

Я потратил дни на поиск Java-редактора Opensource или способ легко редактировать JavaDocs или создавать файлы с информацией о пакете и возвращаться в исходное состояние.

В основном я использую способ изменить способ отображения пакетов. Рамки автоматизации, над которыми я работаю, претерпевают некоторые потенциальные будущие изменения. Эти изменения в двух словах будут организовывать наши тестовые скрипты таким образом, чтобы они были разделены на бизнес-области, а затем на более мелкие пакеты бизнес-функций в этой области.

Мы используем IntelliJ, и генератор JavaDoc по умолчанию создает JavaDocs таким образом, чтобы он составлял список всех пакетов, что я хочу сделать, это создать список основных пакетов (бизнес-областей), а затем подпакеты внутри которых содержат наши тестовые скрипты (бизнес-функции).

Например:

BusinessAreaOne содержат BusinessFunctionOne, BusinessFunctionTwo и BusinessFunctionThree. BusinessAreaTwo содержит BusinessFunctionFour и BusinessFunctionFive. Пакеты BusinessFunction, в свою очередь, содержат скрипты, которые охватывают только эту бизнес-функцию.

Я не смог найти редактор, который делает то, что мне хотелось бы, и я не думаю, что редактирование файлов вручную практически каждый раз, когда есть обновление.

Если нет редактора java с открытым исходным кодом, вы можете сделать это, если есть предложения по работе?

Как я уже говорил, я попытался создать файлы с инкассовой информацией, но насколько я могу судить, вы можете добавить только описание этого пакета. Есть ли какие-либо учебники или кто-нибудь знает, как я могу заставить его отображать список пакетов в выбранном пакете?

Заранее спасибо.

Answer 1

Javadoc не рассматривает иерархии пакетов как вложенные иерархии, он просто сглаживает их всех в список, как вы, вероятно, заметили, поэтому ваши бизнес-функции будут отображаться только как записи в списке между бизнес-областями.

Поиск редактора Javadoc не поможет вам, потому что Javadocs, в котором вы закончили, является результатом процесса компиляции Javadoc, и нет специального тега, который вы можете поместить в свой код, который повлияет на процесс компиляции в который вы ищете.

Вы должны написать что-то, чтобы переопределить реализацию JavaDoc в ее HTML форматировщиком специально для списка пакетов с помощью:

Javadoc Доклеты Вы можете настроить содержание и формат вывода инструмента JavaDoc путем использования доклеты. Инструмент Javadoc имеет встроенный «доклет» по умолчанию, называемый стандартным doclet, который генерирует документацию API в формате HTML. Вы можете изменить или подклассифицировать стандартный документ или написать собственный документ, чтобы генерировать HTML, XML, MIF, RTF или любой другой формат вывода, который вы хотите. Информация о доклетах и ​​их использовании в следующих местах:

Javadoc Doclets

Вы бы использовать собственную реализацию Standard Doclet, найти правильный класс для переопределения - поищите сначала в PackageDoc классе.Я сейчас переживаю этот процесс обучения, но вот the info on Doclet, и в нижней части этой страницы есть ссылка на исходный код, который иллюстрирует, как это сделать.

Конечно, может быть более простой способ сделать это, и если я его обнаружу, я вернусь, чтобы обновить этот ответ.