如何向自定义属性添加文档?

时间:2012-07-19 17:17:11

标签: android xml android-xml attr

我知道如何为视图创建自定义属性,例如:

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <declare-styleable name="SomeViewsCustomAttrs">
        <attr name="someAttr" format="dimension" />
        <attr name="anotherAttr" format="boolean" />
    </declare-styleable>
</resources>    

我想知道是否有办法为这些自定义attrs添加文档。在XML编辑器中编辑布局时,您可以获得描述attrs内容的工具提示。例如,如果您输入android:layout_width=,它将为您提供以下信息,“指定视图的基本宽度。[dimension,enum]”

有没有办法为你自己的attrs提供?

由于

2 个答案:

答案 0 :(得分:4)

为每个元素添加XML注释:

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <declare-styleable name="SomeViewsCustomAttrs">
        <!-- Default highlight color for items that are pressed. -->
        <attr name="colorPressedHighlight" format="color" />
        <!-- Default highlight color for items that are long-pressed. -->
        <attr name="colorLongPressedHighlight" format="color" />
    </declare-styleable>
</resources> 

在您的视图的Java源文件中的Java Doc链接到这样的属性(来自TextView的示例):

* See {@link android.R.styleable#TextView TextView Attributes}, {@link android.R.styleable#View View Attributes}

答案 1 :(得分:-1)

您需要在代码中编写构造函数,然后将它们链接到xml。请阅读this了解详情。