Documenting Your ActionScript Code

[mpc]

Yesterday I had to quickly made a documentation for one of my projects, there are few tools that helped me in this metter. As it turns out creating class documentation for your AS3 project is really easy. Thanks to my Twitter followers I quickly found out that there are few apps that create such a documentation for you, all you have to do is choose a input and output folder

ASDocr

First tool was recently created by Grant Skinner, it’s based on ASDoc. If you want to run it you will need AIR 2 Runtime installed (you can download it here), if you are using the Beta 2 of AIR 2 you will need to download the ASDocr version 1.1 which can be found here, also for those of you who have the eariler version of AIR 2 Runtime please download the ASDocr 1.0 here. After installing you will need to have the Flex SDK on your hard drive (download here).

ASDocr is great and easy to use (also cross-platform) but there is one thing I haven’t liked about it, it only creates documentation from SWC files. You cannot just simply choose a folder that contains your classes, but don’t worry there is another software that does that…

VisDoc

Thats right VisDoc can do this. It’s very simple to use, all you have to do is install, then choose the input and output folder. There are few settings you can choose from before creating your doc. The only disadvantage of VisDoc is that it works only on MAC’s. You can download the VisDoc here.

I also run into great article by Jesse Freeman titled 5 Tips For Documenting Code, this is a must read!

If you know any other tools for documenting ActionScript code please comment.

Kuba.

Read complete blog post here: http://www.blog.mpcreation.pl/documenting-your-actionscript-code/