A Flash Developer Resource Site

Results 1 to 6 of 6

Thread: [RESOLVED] Best practices for describing/commenting Custom Classes

Threaded View

  1. #4
    Senior Member
    Join Date
    Jan 2006
    Posts
    133

    resolved

    Thanks for the input!

    So, I see '@' has a specific meaning when used in Javadoc, i.e. as a tag... so I'm guessing there's not really a "universal-ish" way to use '@', because I'm sure it would change based on personal preference, language, etc? I guess it's use is better determined by the context of whatever follows it =)

    As for ASDoc, I'll have to explore that further...

    I started as an Animator/Designer using Flash and have gradually moved into AS3.0 development... but I've never really explored the 15 dozen tools I COULD use to write/edit .AS files. I've always just stuck with the Flash GUI because most of my projects still use a ton of artwork and graphic assets, so I like being able to bounce around in my library, the stage, and the .AS files... but perhaps migrating to a more robust development environment is the thing to do.

    Plus, Adobe's software suite is so muddled with feature-sets that are duplicated in several of their applications, that you can do just about anything in just about any Adobe software... hell, I think after I installed CS4, .as files by default opened in Dreamweaver. Even odder, .XML files wanted to open in Illustrator.

    ANYWAY, as for ASDoc, I'll do some further reading... but how would I best use that with developing AS files? Could I stay within Flash, or should I migrate to some other edit program?
    Is the chief purpose of ASDoc to generate HTML reference (like the ActionScript 3.0 Language Reference)?

    Anyway, I'm not sure I'll need to jump into generate complete reference documents quite yet... I was more after a preferred way to document classes and such... and what do you know, in Adobe's ASDoc documentation, I found a conveniently titled section: "Documenting ActionScript elements"
    http://livedocs.adobe.com/flex/3/htm..._4.html#189665

    In fact, it seems very similar to Javadoc, so thanks for pointing me in the right direction!!
    Last edited by badaboom55; 04-27-2010 at 12:57 PM.

Tags for this Thread

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  




Click Here to Expand Forum to Full Width

HTML5 Development Center