doc/coding_standards_js.rst
author Alexandre Fayolle <alexandre.fayolle@logilab.fr>
Tue, 03 Jan 2012 17:00:43 +0100
branchstable
changeset 8148 b7a195d54fd4
parent 6049 f0ae98fa85a1
permissions -rw-r--r--
[bfss] convert root BFSS directory to str in constructor (closes #2137793) otherwise you can get crashed with AssertionError: Binary objects must use raw strings, not <type 'unicode'>

Javascript Coding Standards
---------------------------

(Draft, to be continued)

:Naming: camelCase, except for CONSTANTS

Indentation rules
~~~~~~~~~~~~~~~~~
- espace avant accolade ouvrante

- retour à la ligne après accolade ouvrante (éventuellement pas
  de retour à la ligne s'il y a tout sur la même ligne, mais ce n'est
  pas le cas ici.

- no tabs


Documentation
~~~~~~~~~~~~~
XXX explain comment format for documentation generation


Coding
~~~~~~
- Don't forget 'var' before variable definition, and semi-colon (';') after **each** statement.
- Check the firebug console for deprecation warnings


API usage
~~~~~~~~~
- unless intended, use jQuery('container') rather than jqNode('container')


See also
~~~~~~~~
http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml