有沒有辦法定義'javadoc types' - 成員的自定義參數？

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"; 

每個屬性鍵通常應記錄其範圍，其下儲藏物品的種類，誰設置它，誰它是。

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

當然，所呈現的文檔標記應翻譯成英語渲染：A「的javadoc類型/類別」將作如下用途。上述方案的一個重要部分是@AttributeKey標籤 - 這將強制文檔編寫者包含所有必填字段或面對警告消息。

我幾乎肯定Java不存在這樣的事情，但這樣做是否值得，以及其他語言/文檔系統有這樣的功能？

Answer 1

我認爲annotations會更適合您所談論的事物（語義，約束，合同等）。