Javaアプリケーションの自動プロパティードキュメント

Question

Javaアプリケーションの構成プロパティーに「Javadocのような」計測器がありますか？

私は現在、通常のJavaプロパティファイルを使用してJavaアプリケーションを作成しています。これは「エンタープライズアプリ」なので、私たちは何十ものプロパティを持っており、それらのドキュメントをサポートすることは本当に困難です。

私は、たとえばアノテーションを付けてコード内のプロパティを記述し、ドキュメントをファイルにエクスポートするツールやフレームワークを探したいと思います。

すでにJavadocとSwaggerをドキュメント化に使用しています。これは非常に便利です。プロパティに似たものを用意すると便利です。

Answer 1

プロパティファイルのドキュメント生成には、PropDocを使用できます。 PropDocは、Java Propertiesファイルの文書化能力を向上させることを目的としたユーティリティです。

標準Javaプロパティファイルで読み込み、プロパティのコメントからJavaDocのような注釈を解析できます。 Resultは、ファイル内のプロパティに関するドキュメントを生成するために使用できるメタモデルです。

文書をHTML形式で生成するデフォルトのテンプレートがあります。必要に応じてそのテンプレートをカスタマイズできます。その非常に基本的で使いやすい。

PropDocから参照してコードを取得できます。

PropDocは、プロパティファイルの生成に使用できるレディツールです。ソースを参照して自分自身を作成することもできます。