有没有办法定义'javadoc类型' - 成员的自定义参数?

时间:2009-10-19 03:30:53

标签: java javadoc categories custom-tags

我能想到的用例如下:

在典型的应用程序中,通常有许多类别的成员,例如,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";

每个属性键通常应记录其范围,存储在其下的Object类型,设置它的人以及它的用户。 '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不存在这样的事情,但它是否值得以及其他语言/文档系统有这样的功能?

1 个答案:

答案 0 :(得分:2)

我认为annotations会更好地匹配你所讨论的事物(语义,约束,契约等)。