/**
 * Builds the ....
 *
 * @author      Joe Foobar
 * @version     0.1
 * @see         AnotherClass
 */
 
/**
 * We like to place brakets on a new line.
 * That way, they line up with their
 * corresponding closing bracket.
 * Class names are camel case.
 */
 
package
{
 
    class StandardAS3Format
    {
 
        import com.as3.pack.clss;
 
        /**
         * This is unusual, but it works well. Grouping by
         * access modifiers and delimiting with a comma
         * cleans up code nicely.
         * We also prefix global var names with
         * an underscore so they are easily identifiable
         * and user lowercase only.
         */
 
        private var
            _varone    :String,
            _vartwo    :String,
            _varthree  :int;
 
        public var
            _varfour    :uint,
            _varfive    :Object;
 
        public function StandardAS3Format()
        {
            //do something here
        }
 
        /**
         * Arguments passed to a method are prefixed with $.
         * Method names are lower camel case.
         * We always try and have a comment block describing
         * the method and any refences - required for ASDoc.
         */
 
        /**
         * Performs the ....
         *
         * @param       $arg1    description
         * @param       $arg2    description
         * @see         AnotherClass, anotherMethod
         */
 
        public function doSomething($arg1:String, $arg2:int):int
        {
            /**
             * Again, we have vars, each on a new line
             * seperated by a comma. Cleaner and faster!
             */
 
            var
                s1      :String = 'Hello World',
                s2      :String = 'Goodbye World',
                num     :int;
 
            for(num = 0; num < 10; num++)
            {
                //do something
            }
 
            return num;
        }
    }
}