「Javadocタイプ」 - メンバーのカスタムパラメーターを定義する方法はありますか？

Question

私が考えることができるユースケースは次のとおりです。

典型的なアプリケーションでは、通常、特定のカテゴリの多くのメンバーがあります。たとえば、Webアプリケーションには、各カテゴリの多くの定数属性キー、アクションクラス、サービスなどが含まれ、一貫性を維持するために、それらを一貫して文書化することが役立ちます。

属性キーに使用される定数を考慮してください。

/**
 * Request scope attribute key of the {@link com.acme.domain.User} object added by the {@link LoginAction}.
 */
public static final String USER_KEY = "com.acme.web.user";

通常、各属性キーは、その範囲、その下に保存されたオブジェクトのタイプ、それを設定するオブジェクトのタイプ、そしてそれが誰のためであるかを文書化する必要があります。 「Javadocタイプ /カテゴリ」は次のように使用されます。

/**
 * @AttributeKey
 * @scope request
 * @type com.acme.domain.User
 * @source com.acme.web.action.LoginAction#processLogin()
 * @for HomePage.jsp
 */
public static final String USER_KEY = ...;

もちろん、レンダリングされたドキュメントタグは、レンダリングのために英語に翻訳する必要があります。上記のスキームの重要な部分は@AttributeKeyタグです。これにより、ドキュメントライターが必要なすべてのフィールドまたは顔に直面するメッセージを含めることが強制されます。

Javaにはそのようなことが存在しないことはほぼ肯定的ですが、それは価値があり、他の言語 /ドキュメンテーションシステムがそのような機能を持っているのでしょうか？

Answer 1

私はそれを考えるべきです 注釈 あなたが話している種類のこと（セマンティクス、制約、契約など）にもっと合うでしょう。