Tom Ortega II

ASDoc: What comments get used and where do they go?

In Flash*Flex*AS, Programming on April 5, 2007 at 3:36 pm

Josh Buhler was tweeting about ASDoc on Twitter. ASDoc is a little rough to get going, mainly because it’s command-line driven (unless you use Farata Systems Eclipse plugin). I’m not going to get into syntax and such in this post. Instead, Josh wanted a sneak peak at the two files I have on my hard drive. I reckoned if he wanted a peek, some other ASDoc’r would too. Therefore, I’m posting it here for all to view.

What is it?

Basically, the zip has two files of code: 1 mxml file (MXMLTest.mxml) and 1 AS file (ASTest.as). There’s no real code in these files, but there are ASDocs in em. Some start “Used:” while others start with “Ignored:”. The point is to see which ASDoc tags get used and which ones get ignored depending on their location in each of the file types. I keep this posted on my wall and if I have a question, I can glance at them and see when and were to add an ASDoc.

The zip also has the compiled ASDoc output in the ASDocTest folder. To view the output, just unzip the folder and double click the index.html in the ASDocTest folder. Then open to .mxml and .as files in FlexBuilder to see which tags show up in which places.

If you have any questions, let me know. The zip file can be found here: http://360flex.com/downloads/ASDocTest.zip

Note on June 23, 2008: The ASDocTest.zip file has been reuploaded.  Sorry for the inconvenience.

Advertisements
  1. useful,
    thumb up tom 🙂

  2. Hi Tom. You did not touch the problem that private methods are not destilled into the ASDoc. Also Adobe does not support @author and @version afaik. Thx anyway.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: