ZenDoc Documents AS3 Classes

Posted on
7/9/2008 in Tips & Tricks

For someone like me who is not very handy with Ant build files, the command line, ASDoc, and other crap of that nature, getting a nice HTML documentation together for your AS3 class files is a pain in the ass. I know running an Ant build would be much smoother for this kind of thing but I’ve tried doing it and it just doesn’t work for me. A directory that exists is said to not exist and it all just goes to shit from there. Then, magically, ZenDoc saves the day!

I’ve used ZenDoc to document my AS2 classes as you’ve probably noticed in the AS2 Classes section. It was built by Trevor McCauley (more so known as senocular) Today I tried to stick a new class I’m working on in it and lo-and-behold it outputs the correct AS3 documentation! I am so excited that I’m going to go back and add documentation for all my AS3 classes now. YAY!

, ,

If you found this post useful, please consider leaving a comment, subscribing to the feed, or making a small donation.

3 Comments
Pingback by Bookmarks about Build on July 19, 2008 @ 3:15 pm

[...] - bookmarked by 1 members originally found by L3onardo on July 13, 2008 ZenDoc Documents AS3 Classes http://evolve.reintroducing.com/2008/07/09/tips-n-tricks/zendoc-documents-as3-classes/ - [...]

Comment by JP DeVries on September 4, 2008 @ 12:54 pm

If you’re on a Mac VisDoc works great for as2, as3, and js:
http://visiblearea.com/visdoc/

Comment by Matt Przybylski on September 4, 2008 @ 1:34 pm

JP,
Yes, I’ve used VisDoc in the past, but it is not free. ZenDoc does the job for free considering I don’t document whole projects at a time and that is fine. For someone who needs more extensive documentation, I would recommend VisDoc or trying to get ASDoc to work.

Leave a comment

(required)

(required)