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>

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

我做了很多研究，并尝试在标签上进行反复试验，这可能会让我包含描述，但无济于事。有谁知道记录这个的正确方法？

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>

让Android枚举描述出现在JavaDoc中

1 个答案: