flex - robots - Usar ASDoc con metaetiqueta y mxml enlazables

meta name keywords

Question

Estoy creando la documentación de mi proyecto de flexión utilizando ASDoc y teniendo algunos problemas con la metaetiqueta enlazable.

• ASDoc no documenta public Bindable valores public Bindable menos que la etiqueta Bindable tenga un nombre de evento asociado.

Por ejemplo:

//This is documented correctly
[Bindable("someEvent")]
/*
* public bindable with event name
* */
public var test1:String;

//This is not documented at all
[Bindable]
/*
* public bindable without event name
* */
public var test2:String;  

• ASDoc prepede cadenas aleatorias a los nombres de valores protected Bindable si la etiqueta protected Bindable no tiene un nombre de evento asociado.

Por ejemplo:

//This is documented correctly as test3  
[Bindable("someEvent")]  
/*  
* protected bindable with event name  
* */  
protected var test3:String;  

//But this is documented as _110251490test4  
[Bindable]  

/*  
* protected bindable without event name  
* */  
protected var test4:String;

Para resumir, ASDoc no está contento con Bindable etiquetas Bindable sin un nombre de evento. La solución fácil, al parecer, sería especificar un nombre de evento siempre que declare algo como Bindable. Pero los doctores flexibles dicen que si usted especifica un nombre de evento con la etiqueta Bindable, entonces "usted es responsable de generar y despachar el evento". Mi proyecto está casi completo y he confiado en el enlace (sin nombres de eventos) en muchos lugares, por lo que no es práctico retroceder y cambiar todo: va a necesitar mucho esfuerzo; además, la idea de estropear el código de trabajo para crear documentación me resulta aterradora.

Reemplazar todas las instancias [Bindable] con [Bindable("blah")] antes de generar asdoc y luego volver a cambiarlas es la única solución que se me ocurre. Pero siento que debería haber una mejor manera.

Adobe bug tracker afirma que el problema con las variables públicas se ha solucionado en la versión más reciente, así que descargué el último flex sdk (3.4) y lo intenté con el ASDoc que lo acompañaba, pero me dio el mismo resultado.

¿Alguien puede arrojar algo de luz sobre este tema?

Además, el blog de Adobe dice que ASDoc también admite mxml, pero cuando probé con el último ASDoc (flex 3.4), mis comentarios de mxml asdoc (incrustados) no aparecían en la página html que se generó. ¿Alguien sabe si el último asdoc está disponible para descargar por separado?

Answer 1

No proporcionas ningún número de Jira para verificar, pero ...

Los cambios de ASDoc para MXML solo están en Flex 4 (IIRC), verificaría que el error de enlace no sea el mismo.

Answer 2

Si bien no puedo ayudarlo con una solución alternativa, el problema es que [Bindable] (sin nombre de evento) genera un código de envoltura (creo que una propiedad separada) alrededor de la propiedad. Este código obviamente está jugando con asdoc.