有没有办法定义'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会更适合您所谈论的事物（语义，约束，合同等）。