doc/coding_standards_js.rst
author Julien Cristau <julien.cristau@logilab.fr>
Fri, 22 Jun 2012 15:57:05 +0200
branchstable
changeset 8453 f441056a2b61
parent 6049 f0ae98fa85a1
permissions -rw-r--r--
[packaging] bump rql dependency to 0.29 (closes #2410042) Needed for add_eid_restriction with 4 args, usage of which was introduced in changeset aed065b97f12 (refactor entity fetch_rql method to use a RQL syntax tree instead of RQL strings)

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