1

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

典型的なアプリケーションでは、通常、特定のカテゴリの多くのメンバーが存在します。たとえば、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にはそのようなものが存在しないことはほぼ間違いありませんが、それは価値があり、他のどの言語/ドキュメントシステムにそのような機能がありますか?

4

1 に答える 1

2

注釈は、あなたが話している種類のもの (セマンティクス、制約、コントラクトなど) により適していると考えるべきです。

于 2009-10-19T03:44:06.857 に答える