Документация по автоматическим свойствам для приложения Java

Существуют ли инструменты Javadoc-like для свойств конфигурации в приложении Java?

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

Итак, я хочу найти инструмент или фреймворк, который позволяет описывать свойства в коде, например, с аннотациями, а затем экспортировать документацию в файл.

Мы уже используем Javadoc и Swagger для документации - это довольно удобно. Было бы полезно иметь что-то подобное для свойств.

Ответы

Ответ 1

Вы можете использовать PropDoc для создания файла свойств. PropDoc - это утилита, которая направлена на повышение документабельности файлов свойств Java.

Он может читаться в стандартном файле свойств Java и анализировать аннотации, подобные JavaDoc, из комментариев свойств. Результат - это метамодель, который может использоваться для создания документации о свойствах в файле.

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

Вы можете ссылаться и получать код отсюда PropDoc.

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