2016-09-13 3 views
11

Gibt es "Javadoc-ähnliche" Instrumente für Konfigurationseigenschaften in Java-Anwendungen?Dokumentation der automatischen Eigenschaften für Java-Anwendung

Ich arbeite derzeit an Java-Anwendung, die üblichen Java-Eigenschaftendateien für die Konfiguration verwendet. Dies ist eine "Unternehmens-App", also haben wir Dutzende von Eigenschaften und es ist wirklich schwierig, Dokumentation für sie zu unterstützen.

Ich möchte also ein Werkzeug oder Framework finden, das es ermöglicht, Eigenschaften im Code zu beschreiben, zum Beispiel mit Anmerkungen, und dann die Dokumentation in eine Datei zu exportieren.

Wir verwenden bereits Javadoc und Swagger für die Dokumentation - es ist sehr praktisch. Es wäre hilfreich, etwas ähnliches für Eigenschaften zu haben.

+0

Vielleicht [diese SO] (http://stackoverflow.com/questions/28385079/how-to-document-properties-files) könnte nützlich sein. Nicht sicher, ob es für Ihr Projekt erschwinglich ist – user3159253

+0

Sind die Eigenschaften alle an einem einzigen Ort (z. B. einige Bohnen/Singleton, die sich mit Eigenschaften befasst), oder verwendet die App unterschiedliche Eigenschaften an verschiedenen Orten der App? Suchen Sie auch nach Eigenschaften auf einem Feld/Methode/Klassenebene kommentiert? Von Interesse, die [Javadocs] (https://docs.oracle.com/javase/7/docs/api/java/lang/System.html#getProperties()) beschreibt ihre Standard-Systemeigenschaften als Teil von ihre Javadocs. –

+0

Alle Eigenschaften befinden sich in Feldern unterschiedlicher Klassen. Da unsere Anwendungen pluginbasierte Architektur haben und ein Plugin eigene Systemeigenschaften haben kann, können wir nicht alle Eigenschaften an einen einzigen Ort verschieben. –

Antwort

9

Sie können PropDoc für die Eigenschaftendatei Dokumentgenerierung verwenden. PropDoc ist ein Dienstprogramm, das die Dokumentationsfähigkeit von Java-Eigenschaften-Dateien verbessern soll.

Es kann in einer Standard-Java-Eigenschaftendatei lesen und JavaDoc-ähnliche Anmerkungen aus den Kommentaren der Eigenschaften analysieren. Ergebnis ist ein Metamodell, mit dem eine Dokumentation über die Eigenschaften in der Datei generiert werden kann.

Es gibt eine Standardvorlage, die Ihr Dokument im HTML-Format generiert. Sie können diese Vorlage Ihren Bedürfnissen anpassen. Es ist sehr einfach und einfach zu bedienen.

Sie können beziehen und Code von hier erhalten PropDoc.

PropDoc ist ein fertiges Tool, das für die Generierung von Eigenschaftendateien verwendet werden kann. Sie können auch Ihre eigenen erstellen, indem Sie auf die Quelle verweisen.

Verwandte Themen