java – Android中有自定义XML风格属性的文档标准？

我能够在我的 Android项目中记录几乎所有内容,并为他们生成漂亮的API参考.

唯一的例外是XML文件,特别是包含样式属性的属性文件.

例如,res / values / attrs.xml的一部分：

<resources>
    <declare-styleable name="TimelineView">
        <attr name="drawCollapsed" format="boolean" />
    </declare-styleable>
</resources>

我注意到在Android的源码,standard attributes documentation is generated for R.

显然,我生成的文档包含一些属性类型的通用文本(在本例中为布尔值)：

是否有这种类型的文档的官方规范或者是一种记录源自XML的属性的方式,以便描述出现在自动生成的JavaDoc中？

解决方法

我不知道这是一个官方的标准,但是在写我的问题时我偶然发现.我决定发布问题,无论如何,为了可能遇到这个问题的其他人的缘故.

我能够通过在属性上面添加一个XML注释来生成属性文档,现在我已经看到了这一点.

我最初没有重建我的项目,这导致原来缺乏文档.一旦我重建了该模块并生成了JavaDoc,就得到了所需的结果.

要遵循的步骤是：

>将注释置于所需属性之上.

<resources>
    <declare-styleable name="TimelineView">
        <!-- Initially draw collapsed until adapters have been set. -->
        <attr name="drawCollapsed" format="boolean" />
    </declare-styleable>

</resources>

>重建相关模块/项目.
>生成JavaDoc.使用Android Studio(目前为0.5.8).
目前有small issue与自动生成,我正在使用解决方法介绍在第一个链接的帖子.
生成的文档应包含您的意见.

如果有人知道这个或官方方法的任何官方来源,请不要犹豫,分享.

更新：
看来这确实是在Android source files中完成的,包括一些JavaDoc指令,HTML和子注释在注释中,例如：

<!-- Alignment constants. -->
<attr name="alignmentMode">
    <!-- Align the bounds of the children.
    See {@link android.widget.GridLayout#ALIGN_BOUNDS}. -->
    <enum name="alignBounds" value="0" />
    <!-- Align the margins of the children.
    See {@link android.widget.GridLayout#ALIGN_MARGINS}. -->
    <enum name="alignMargins" value="1" />
</attr>

java – Android中有自定义XML风格属性的文档标准？

解决方法

猜你在找的Android相关文章