添加文档到布局文件

时间:2013-09-12 14:39:49

标签: android android-layout documentation android-resources aapt

我正在寻找一种记录布局文件的方法,以提高其可重用性。 我想要的是在生成的R文件中生成javadoc的东西。

我知道在使用<declare-styleable>时可以这样做。这个:

<declare-styleable name="myStyleable">
    <!-- Some comment -->
    <attr name="someAttr" format"color" />
</declare-styleable>

生成此输出我想获取布局文件但没有成功:

public final class R {
    /** Some comment */
    public static final int someAttr...
}

有人知道实现这个目的的意思吗?我对此感兴趣:

  • 记录布局文件,以便在使用R.layout.my_layout
  • 时可以使用文档
  • 记录文件的特定元素,以便在通过id f.e查找文档时可以获得文档。 aView.findViewById(R.id.the_id_that_is_documented)

1 个答案:

答案 0 :(得分:0)

顺便说一下,我找到了部分响应:对于id,如果id在资源文件中定义(在res/values中),则可以添加注释:

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <!-- This is a comment -->
    <item name="myId" type="id"></item>    
</resources>

将在R.class中生成此结果:

public final class R {
    public static final class id {
    /**  This is a comment 
     */
    public static int myId=0x7f050007;
}

如果您使用@+id/some_cute_id

,这将无法直接在布局文件中使用

编辑,这是布局文件的答案。实际上它可能适用于所有事情(发现它在res/values/public.xml中浏览sdk源代码)。这个:

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <!-- 
         * This layout contains a list that enables to choose a bluetooth device to pair with among paired ones -->
    <public type="layout" name="devices_choose" id="0x7f030005" />    
</resources>

在R:

中生成此输出
public final class R {
    public static class layout {
        /**  
         * This layout contains a list that enables to choose a bluetooth device to pair with among paired ones 
         */
        public static final int devices_choose=0x7f030005;
    }
}