I’ve been a big fan of the ASDoc tool since I first found out it was in the Flex SDK. Just in case you’re not sure what ASDoc is, it’s command-line tool that’s used to generate documentation for your code, just like the online documentation that Adobe provides for Flex and ActionScript 3.0.
Unfortunately, setting up and using ASDoc isn’t the most intuitive thing in the world, and the documentation on how to use it is a bit sparse. I’ve always found it a bit ironic that a tool for generating documentation has been so under-documented. It took a bit of figuring out, but I was eventually able to get it working, and have been using it for a while now. I later got it working in Flex Builder via the External Tools dialog, so updating the docs for a project is as easy as clicking one button – once you get things set up properly.
I’ve been meaning to blog about this for a while, and provide a write-up on how to get things setup. However, I’m also a bit of a slacker, and haven’t got around to writing that post. Luckily, I don’t need to anymore. Seb Lee-Delisle has written up a great set of instructions on setting up and using ASDoc in Flex Builder. I definitely recommend that you check them out, and if you’re not already using ASDoc as part of your workflow, you probably should.
Link: How to set up ASDoc in Flex Builder
Also, if you don’t use Flex Builder, but still want what appears to be easy way to use ASDoc, you may want to check out Devon O. Wolfgang’s ASDoc GUI – AIR app created to make using ASDoc a little bit easier. Unfortunately, the AIR app uses a Windows-only helper application, so I haven’t been able to check it out to see how well it works.
