android - 让 Android 枚举描述出现在 JavaDoc 中

Question

我在 xml 中定义了一个自定义属性，它必须将 enum 值作为参数。从我的应用程序的 R.attr 自动生成的 JavaDoc 构建了一个包含 enum 名称和值的表，但我无法填写描述列。如何定义将出现在 JavaDoc 中的描述？

带有 enum 常量的示例属性:

<declare-styleable name="MyCustomView">
    <attr name="directions">
        <enum name="up" value="0" />
        <enum name="down" value="1" />
        <enum name="left" value="2" />
        <enum name="right" value="3" />
    </attr>
</declare-styleable>

为了说明我的意思，directionPriority 的 JavaDoc在 android.R.attr 中有一个表，包含所有可能的枚举，其中包含“常量”、“值”和“描述”。

我进行了大量研究，并尝试对可能允许我包含描述的标签进行反复试验猜测，但无济于事。有谁知道记录这个的正确方法？

Answer 1

解决方案是在每个枚举之前添加注释。这些注释会自动翻译成枚举描述列。

<declare-styleable name="MyCustomView">
    <attr name="directions">
        <!-- Go up! -->
        <enum name="up" value="0" />
        <!-- Go down! -->
        <enum name="down" value="1" />
        <!-- Go left! -->
        <enum name="left" value="2" />
        <!-- Go right! -->
        <enum name="right" value="3" />
    </attr>
</declare-styleable>