有没有办法定义'javadoc types' - 成员的自定义参数？

Question

我能想到的用例如下：

在一个典型的应用程序中，通常有许多属于某个类别的成员，例如，一个 Web 应用程序包含许多常量属性键、Action 类、服务等。对于每个类别，为了保持一致性，将它们记录在案是很有用的始终如一。

考虑用于属性键的常量：

/**
 * 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

我应该认为annotations 更适合您正在谈论的事物（语义、约束、合同等）。