The ASDoc tool

The ASDoc Tool

Further to my post on Java Style Docs with ZenDoc, I’ve found and used a better tool ASDoc.

I’ve used parts of FDTKit to enable an ANT script to create a directory with the documentation.

The process of using FDTKit can be viewed here: FDTKit Documentation & Usage Guide, theres too much information here for just running the “doc-asdoc” from the build.xml.

The build.xml should be present at the ‘top level’ of the checked out project

Comments in the ActionScript Code should follow wherever possible the Java standard : Javadoc comments should have the following form

Not all the Javadoc tags are supported though, for a list of supported tags see: ASDoc tags

For using the @see tag see:
Using the @see tag

Advertisements

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