ActionScript 3 - Comment Guidelines / Rules

Do any of you follow any guidelines or rules for commenting your actionscript documents.

I think it is important to find a good pattern in your commenting when working with a team of developers in multiple actionscript files.

Are there unwritten rules to comment your classes, constructors and methods.

Or maybe use the javadoc syntax. I don't know if the javadoc program also works for other files than .java.

Greetings Ontani

Hi, I stick to the javadoc format except when posting here :¬)

does the javadoc parser accept different types of files when trying to extract and export the documentation?

Well, the Sun tool doesn't. Senocular was working on a tool called ZenDoc but it's kinda outdated now. He has a list of alternatives on the ZenDoc page though.

Personally I haven't used any of them. I write my comments this way because I use FlashDevelop which natively supports the javadoc format. If any of the clients request such detailed information then it is readily available and I can then look into the list I just posted.

I did indeed came to the solution that Senocular made (ZenDoc) and was pretty pleased with this, didn't notice it was that much out of date.

I'll take a look at the list of alternatives tonight, should find something interresting.

Otherwise zendoc still look like a great alternative.

ah, that's good to know. I was just basing that off the ZenDoc news page where he says he hasn't had much time to work on it and hopes to get some more done prior to the CS3 suite being released. Doesn't say anything after that which led me to believe he hadn't achieved that goal.

Don't think it matters what version of actionscript your working with. The comments are still the same and the documents are generated fully on the comments you place so it shouldn't matter if was made in Actionscript 1 or ActionScript 9^³ :-). The tests i did went pretty succesfull and the examples that are included look pretty advanced enough,to parse the docs that i want to.

On the other side, I have no idea what i'm talking about, i just started with actionscript last week :-)