configuration - software - ¿Puedo usar DoxyGen para documentar el código de ActionScript?
herramienta para documentar software (3)
¿Cómo configuro DoxyGen para documentar los archivos de ActionScript?
He incluido los archivos * .as y * .asi en el patrón de búsqueda de doxygen, pero las clases, funciones y variables no se muestran allí.
En lugar de doxygen, debe usar un generador de documentación que soporte específicamente el lenguaje. Para ActionScript 2, tiene un par de opciones:
- NaturalDocs ( ejemplo ) (gratis)
- ZenDoc (gratis)
- AS2Doc Pro ( ejemplo ) (comercial)
Si está utilizando ActionScript 3, Adobe incluye un generador de documentación gratuito junto con su compilador de código abierto (el SDK de Flex ), llamado " ASDoc ". Si está utilizando FlashDevelop , la última versión beta tiene una GUI incorporada para ejecutar ASDoc, por lo que no tiene que ensuciarse las manos con la línea de comandos.
He podido producir ALGUNA documentación con DoxyGen (¿Qué puedo decir? Me gustan sus características y capacidades) Al hacer lo siguiente:
Agregue * .as y * .asi a la lista de tipos de archivos para ingresar.
Seleccionar:
OPTIMIZE_OUTPUT_JAVA = YES
EXTRACT_ALL = YES
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
Otro problema en AS3 es la declaración del paquete. Necesita decirle a DoxyGen que ignore la definición del paquete. Esto es fácil de hacer usando cond. Entonces cambiarás la línea:
package myPackage {
dentro
/// @cond
package myPackage {
/// @endcond
Lo que hará que Doxygen ignore la (s) línea (s) entre cond y endcond. Tenga en cuenta que parece que no hay necesidad de hacer lo mismo para el corchete de cierre en la parte inferior de su archivo .as.
También puedes usar Ortelius. Es más fácil de usar que ASDoc, ya que viene con una GUI simple, y es más perdonable para tu código. Es gratuito y de código abierto, pero solo para Windows.