2016-09-13 4 views
11

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

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

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

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

+0

Возможно [это СО] (http://stackoverflow.com/questions/28385079/how-to-document-properties-files) может быть полезно. Не уверен, что это доступно для вашего проекта. – user3159253

+0

Являются ли все объекты, расположенные в одном месте (например, некоторые bean/singleton, которые имеют дело со свойствами), или приложение использует разные свойства в разных местах приложения? Кроме того, вы ищете свойства, аннотированные на уровне поля/метода/класса? Из интереса [Javadocs] (https://docs.oracle.com/javase/7/docs/api/java/lang/System.html#getProperties()) описаны их системные свойства по умолчанию как часть их джавадоки. –

+0

Все объекты находятся в полях разных классов. Поскольку наши приложения имеют плагиновую архитектуру, а плагин может иметь собственные системные свойства, мы не можем перенести все свойства в одно место. –

ответ

9

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

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

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

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

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