代码之家  ›  专栏  ›  技术社区  ›  les2

是否有方法定义“javadoc类型”-成员的自定义参数?

  •  1
  • les2  · 技术社区  · 16 年前

    我能想到的用例如下:

    在典型的应用程序中,通常有许多特定类别的成员,例如,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不存在这样的东西,但它是否值得,其他语言/文档系统有什么特点呢?

    1 回复  |  直到 14 年前
        1
  •  2
  •   Jonathan Feinberg    16 年前

    我应该这么想 annotations 对于您所说的类型(语义、约束、契约等),这将是更好的匹配。