有没有办法定义“ 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

我应该认为 注释 对于您所谈论的事情（语义，约束，合同等），将是更好的匹配。