RE: [flexcoders] Comments in source code

[Steven Webster]

Guys,   There are a number of ASDoc style tools that are freely and commercially available for ActionScript, that will perform JavaDoc style documentation, using the /** ... */ comment style, and tags such as @author, @description, etc.   Prior to joining Macromedia/Adobe, we successfully used AS2Doc (http://www.as2doc.com) to deliver API-level documentation from MXML and ActionScript 2.0 source.  I know there are other tools (I remember people talking about NaturalDocs -- perhaps Aral Balkan can provide more detail, I know he championed this for a while) as an alternative that they liked, but AS2Doc "did what it said on the tin" for me.   Perhaps that's what you're looking for ?   Best,   Steven   -- Steven Webster Practice Director (Rich Internet Applications) Adobe Consulting EMEA   Office: + 44 (0) 131 338 6108 Mobile: +44 (0) 7917 428 947   From: flexcoders@yahoogroups.com [mailto:[EMAIL PROTECTED] On Behalf Of Nick Weekes Sent: 09 December 2005 11:45 To: flexcoders@yahoogroups.com Subject: RE: [flexcoders] Comments in source code Ralf, do you mean the Visual Studio ability to generate html pages from code comments, which is really useful for auto-documenting code?   I dont think there is a Flex equivalent of the /// tag found in visual studio. From: flexcoders@yahoogroups.com [mailto:[EMAIL PROTECTED] On Behalf Of Ralf Rottmann Sent: 09 December 2005 11:40 To: flexcoders@yahoogroups.com Subject: RE: [flexcoders] Comments in source code Thanks Philippe,   I was aware of the two comment styles, my question was more about comment conventions which might be used to automatically craft dev docs in a later version.   Ralf Rottmann | Director Sales & Marketing | VoicInt Telecommunications GmbH m:+49-(0)170-914-5495 | f: +49-(0)231-557402-99 | e: [EMAIL PROTECTED] ------------------------------------------------------------------------------------------------------- From: flexcoders@yahoogroups.com [mailto:flexcoders@yahoogroups.com] On Behalf Of Philippe Maegerman Sent: Freitag, 9. Dezember 2005 12:13 To: flexcoders@yahoogroups.com Subject: RE: [flexcoders] Comments in source code   you can use html comments in the mxml code: <!--- @Author:xxx --->   in Actionscript it's gonna be // for commenting lines and /* */ for commenting blocks.   Philippe     From: flexcoders@yahoogroups.com on behalf of Ralf Rottmann Sent: Fri 9/12/2005 12:09 To: flexcoders@yahoogroups.com Subject: [flexcoders] Comments in source code I wonder: Are there any specific “rules” for comments which might help to automatically assemble code doc later? Anything like   // @Parameters:            <in>theNumber:Number  The number of loops to be done   …   ?     Ralf Rottmann | Director Sales & Marketing VoicInt Telecommunications GmbH | Lindemannstrasse 78 | 44137 Dortmund | Germany p: +49-(0)231-557402-11 | f: +49-(0)231-557402-99 | m:+49-(0)170-914-5495 | e: [EMAIL PROTECTED] ----------------------------------------------------------------------------------------------------------------------------------------- Besuchen Sie uns auf der CallCenterWorld 2006, 13.-16. Februar 2006, Estrel Convention Center, Berlin Sie finden uns am Stand 1C18. Erleben Sie unsere Produkte live und ganz ohne PowerPoint!   -- Flexcoders Mailing List FAQ: http://groups.yahoo.com/group/flexcoders/files/flexcodersFAQ.txt Search Archives: http://www.mail-archive.com/flexcoders%40yahoogroups.com SPONSORED LINKS Web site design development Computer software development Software design and development Macromedia flex Software development best practice     YAHOO! GROUPS LINKS    Visit your group "flexcoders" on the web.    To unsubscribe from this group, send an email to:  [EMAIL PROTECTED]    Your use of Yahoo! Groups is subject to the Yahoo! Terms of Service.     -- Flexcoders Mailing List FAQ: http://groups.yahoo.com/group/flexcoders/files/flexcodersFAQ.txt Search Archives: http://www.mail-archive.com/flexcoders%40yahoogroups.com YAHOO! GROUPS LINKS  Visit your group "flexcoders" on the web.    To unsubscribe from this group, send an email to:  [EMAIL PROTECTED]    Your use of Yahoo! Groups is subject to the Yahoo! Terms of Service.