Folosirea utilitarului ASDoc la documentarea bibliotecilor in Flex

Atunci cand dezvoltati aplicatii Flex sau AIR este indicat sa aveti un proiect structurat si cu surse bine documentate.

Similar cu JavaDoc pentru Java, ASDoc analizeaza unul sau mai multe definitii de clasa ActionScript si fisiere MXML si genereaza o structura de fisiere HTML pentru toate metodele publice, protejate cat si pentru proprietati.

ASDoc este un instrument ce se apeleaza din linie de comanda, dar aveti posibilitatea sa configurati Eclipse/Flash Builder in asa fel incat sa puteti rula ASDoc prin simpla apasare a unui buton. Acest tutorial va arata cum sa faceti acest lucru.

Aici aveti un exemplu de documentatie generata cu ASDoc folosind Flash Builder:
Exemplu de folosire de ASDoc

Pentru configurare vom adauga instrumentul ASDoc la instrumentele externe si ii vom seta locatia, directorul proiectului si directorul de surse. Daca in proiectul dumneavoastra se afla si biblioteci externe (fisiere SWC) ele trebuiesc specificate de asemenea (Arguments: -external-library-path: libs).

Location: calea catre instrumentrul ASDoc din Flash Builder
Working directory: locatia proiectului
Arguments: -source-path src and -doc-sources src

Dupa configurare ar trebui sa arate asa:
Configurare ASDoc

Nu ne ramane de facut decat sa generam documentatia apasand pe butonul External Tools din Flash Bulder, iar rezultatul il vom gasi in directorul asdoc-output din proiectul dumneavoastra.
Documentatie generata cu ASDoc

Mai jos aveti un tabel cu tag-urile ce sunt recunoscute de instrumentul ASDoc

  ASDoc tag Descriere Exemplu
  @copy reference
  @default value
  @eventType package.class.CONSTANT@eventType String
  @example exampleText
  @exampleText string
  @includeExample textFile
  @inheritDoc
  @internal text
  @param paramNamedescription
  @private
  @return description
  @see reference[displayText]
  @since text
  @throws package.class.className description