Use AsDoc for documenting your code so we can automatically create documentation of the codes. We will use AsDoc tool found on Flex SDK. Follow code commenting found on Adobe Documentation

No need to add author name using @author on the source code.

Class Example:

1
2
3
4
5
6
7
8
9
10

/**
 *  The Button control is a commonly used rectangular button.
 *  Button controls look like they can be pressed.
 *
 *  <p>The <code>&lt;mx:Button&gt;</code> tag inherits all the
 *  tag attributes of its superclass, and adds the following:</p>
 *
 *  mx:Button
 */
public class Button extends UIComponent

Method Example:

1
2
3
4
5
6
7

/**
* @private
* Displays one of the eight possible skins,
* creating it if it doesn't already exist.
*/
private function viewSkin():void
{

Implementation comment always use // instead of /* */

1
2
3
4

// this comment is so long that we need to add newline
if (!visibleColumns || visibleColumns.length == 0)
 
var a:int = 5; // this is short comment