Join FlipAndroid.COM Telegram Group: https://t.me/joinchat/F_aqThGkhwcLzmI49vKAiw


¿Existe un estándar de documentación para atributos personalizados de estilo XML en Android?

Puedo documentar casi todo en mis proyectos de Android y generar interesantes referencias de API para ellos.

La única excepción a esto son los archivos XML, y especialmente los archivos de atributos que contienen los atributos con estilo.

Por ejemplo, una parte de res / values ​​/ attrs.xml :

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

Me di cuenta de que en la fuente de Android, la documentación de atributos estándar se genera para R.

Mi documentación generada, obviamente, incluye algún texto genérico para mi tipo de atributo (booleano, en este caso):

Propiedad auto-documentada

¿Existe una especificación oficial para este tipo de documentación o una forma de documentar los atributos que se originan en XML de tal manera que la descripción aparece en el JavaDoc generado automáticamente?

  • Biblioteca Java usando selectores css para analizar XML
  • Android LinearGradient XML
  • ¿Por qué tengo espacio en blanco en la parte superior y en la parte inferior de mi ImageView en mi RelativeLayout?
  • Buscar en archivo XML con XPath en Android
  • Match_parent no funciona para ListView, si ListView está dentro de NestedScrollView
  • No se puede activar el modo de vista previa Android Studio
  • Edición de Android Dibujo de rutas largas en MapView mediante análisis XML
  • ¿Definir el logotipo personalizado para ActionBar (diferente de Logo) en XML?
  • One Solution collect form web for “¿Existe un estándar de documentación para atributos personalizados de estilo XML en Android?”

    No estoy seguro de que este es un estándar oficial, pero me tropecé con él al escribir mi pregunta. Decidí publicar la pregunta y contestarla de todos modos, por el bien de otros que podrían encontrar este problema.

    Pude generar la documentación del atributo agregando un comentario de XML sobre el atributo, que parece bastante evidente ahora que lo he visto.

    Lo intenté inicialmente sin reconstruir mi proyecto, que conducen a la falta original de la documentación. Una vez que reconstruí el módulo y generé el JavaDoc, conseguí el resultado deseado.

    Los pasos a seguir son:

    1. Coloque un comentario sobre los atributos deseados.

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

    2. Reconstruya el módulo / proyecto relevante.

    3. Genere el JavaDoc. Uso de Android Studio (actualmente 0.5.8).
      Actualmente hay un pequeño problema con la generación automática, estoy usando la solución que se introdujo en la primera publicación enlazada.
      La documentación generada debe contener sus comentarios.
      Documentación deseada

    Si alguien sabe de alguna fuente oficial para esto o un método oficial, por favor no dude en compartirlos.

    Actualizar:
    Parece que esto es de hecho la forma en que se hace en los archivos fuente de Android , incluyendo algunas directivas JavaDoc, HTML y anotación de niño en los comentarios, por ejemplo:

     <!-- 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> 
    FlipAndroid es un fan de Google para Android, Todo sobre Android Phones, Android Wear, Android Dev y Aplicaciones para Android Aplicaciones.