Javascript style coding

[atarkowska]

We should define one common coding style in order to have consistent code and easy readable.

APIDoc:

• JSDoc Toolkit ​http://code.google.com/p/jsdoc-toolkit/
• YUIDoc ​http://yuilibrary.com/projects/yuidoc

    /**
    * Reverse a string
    *
    * @param {String} input String to reverse
    * @return {String} The reversed string
    */
    var reverse = function (input) {
        // ...
    return output;
};

Javascript:

• ​http://net.tutsplus.com/tutorials/javascript-ajax/the-essentials-of-writing-high-quality-javascript/

• ​http://amix.dk/blog/post/19496
• ​http://www.adequatelygood.com/2010/3/JavaScript-Module-Pattern-In-Depth
• ​http://javascript.crockford.com/code.html
• ​http://www.komodomedia.com/blog/2008/09/javascript-classes-for-n00bs/
• ​http://www.codeproject.com/kb/aspnet/JsOOP1.aspx

jQuery:

• ​http://www.myinkblog.com/2009/08/04/10-tips-for-writing-better-jquery-code/

Public
Public functions and variables are available to access on an instance of a class.

    function MyClass () {
        //..
    }

    //public member variable
    MyClass.prototype.publicVar = "My Public Variable";

    //public member function
    MyClass.prototype.publicFunction = function () {
        alert( this.publicVar );
    }

    //create an instance
    var oClass = new MyClass();

    //run a member function
    oClass.publicFunction(); //Alert: "My Public Variable"

Private
Private member functions and variables are hidden to outside code. Only public functions can access them.

    function MyClass () {

        //reference to this
        var self = this;

        //private member variable
        var privateVar = "My Private Variable";

        //public member variable
        this.publicVar = "My Public Variable";

        //private member function
        //shorthand function privateFunction() {...}
        var privateFunction = function () {

            self.publicVar += " Modified By A Private Fucntion";

            alert( self.publicVar );

        }
    }

    //create an instance
    var oClass = new MyClass();

    //run a private member function
    oClass.privateFunction(); //private function is undefined

    //get a private member var
    alert( oClass.privateVar ); //private var is undefined

Privileged
A privileged member function has access to private variables, but is available publicly.

    function MyClass () {

        //private member variable
        var privateVar = "My Private Variable";

        //privileged member function
        this.privilegedFunction = function () {
            alert( privateVar );
        }
    }
    
    //create an instance
    var oClass = new MyClass();

    //run a privileged member function
    oClass.privilegedFunction(); //Output: alerts the value of the private var

Static
A static function or variable is available on the base class (or JavaScript?) function, but is not available to the class instance.

    function MyClass () {
        //...
    }

    //declare a static member
    MyClass.staticVar = "My static variable";

    //declare a static function
    MyClass.staticFunction = function ( pInput ) {
        return new MyClass( MyClass.staticVar , pInput );
    }

    //create an instance
    var oClass = new MyClass();

    //run a static function (NO access to private or public)
    oClass.staticFunction( 9 ); //staticFunction is undefined on an instance
    
    //run a privileged member function on the class
    MyClass.privilegedFunction(); //The function runs
    

[jburel]

Moved from sprint 2011-02-10 (5)

[wmoore]

Referencing ticket #3300 has changed sprint.

[wmoore]

I vote for using Crockford's style, since we are now using jsHint.