Well since I’m planning on building up a small repository of classes on here I thought it time to be a bit more serious with my class documentation.
Documentation mark up.
So I don’t forget, I wanted to include two good links for ASDoc best practices from Adobe livedocs.
- AS Doc Comments.
http://livedocs.adobe.com/flex/3/html/help.html?content=asdoc_3.html - AS Doc Tags.
http://livedocs.adobe.com/flex/3/html/help.html?content=asdoc_6.html#186140
Exporting AS Documentation in Flash Bulder.
Peter Elst has a good short tutorial on how to set up Flash Builder to export AS Documentation on his blog peterelst.com. There is also a more in depth tutorial at http://knomedia.com/ by Jason Madsen.
Naming Conventions.
And a good article on naming conventions by Stephen K. Friedrich on gentleware.com.


Post a Reply