首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >如何Javadoc类的单个枚举

如何Javadoc类的单个枚举
EN

Stack Overflow用户
提问于 2011-07-01 23:13:04
回答 1查看 67.5K关注 0票数 89

我正在为一个包含自己枚举的类编写Javadoc。有没有办法为各个枚举生成Javadoc?例如,现在我有这样的东西:

代码语言:javascript
复制
/**
 * This documents "HairColor"
 */
private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED };

但是,这只是将所有枚举作为一个整体来记录:

有没有办法单独记录每个HairColor值?而不将枚举移入其自己的类或将其从枚举中更改?

EN

回答 1

Stack Overflow用户

发布于 2014-04-24 18:52:53

您可以创建指向每个枚举项目的链接。所有项目都将在javadocs to enum类中列出。

代码语言:javascript
复制
/**
 *  Colors that can be used
 *  {@link #RED}
 *  {@link #BLUE}
 */
public enum Color {

    /**
     * Red color
     */
     RED,

    /**
     * Blue color
     */
    BLUE
}
票数 76
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/6549821

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档