Quality Management:Quality manual/Work instructions/JavaScript coding standard

From PMISwiki
< Quality Management:Quality manual‎ | Work instructions
Revision as of 16:30, 13 April 2011 by WikiSysop (talk | contribs) (Created page with "This document is not released - Draft version only This coding standard is used for all JavaScript programming. That is, but not limited to, JavaScript and extensions to Dojo, Y...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This document is not released - Draft version only

This coding standard is used for all JavaScript programming. That is, but not limited to, JavaScript and extensions to Dojo, YUI, jQuery and Prototype.

The scope of this document is to define coding standards related to the JavaScript language. Review and quality control is not covered herein. Please refer to Review procedure.

JavaScript

This document is under preparation, the following areas should be covered:

  • xxx

Validation

All released java scripts must be validated by JSLint.com or similar tools, However, the following exceptions are allowed: • It is not recommended to use the “ (??) Any excatpion shall be explained in the comments to the actual code line.

Furthermore, the script shall be run in Firefox and verified in the error consoleFirebug. tools, error console


File header

All source files must contain a file header with informations specified by the procedure for Control of Documents. An practical example may be found below:#Document History. Text to copy into the source file may be found here:Source file header.


Function names

All functions names starts with low-case.

Constructor

The variable name of variable containing a function reference must start upper-case.

var Person = function(name){
                this.name = name;
              }
var eljefe = new Person (Peter Stig Andersen);
print(eljefe.name);

OR:

#include <iostream>

int main()
{
   std::cout << "Hello, world!\n";
}

This is to avoid programming errors where the lack of "new" would lead to use/modification of the global context.

Dojo

References

Document History

Version Date Author Status Purpose of update
0 13 Apr 2011 PSA Draft New document