doc/coding_standards_js.rst
author Julien Jehannet <julien.jehannet@logilab.fr>
Wed, 07 Sep 2011 11:37:41 +0200
branchstable
changeset 7767 07c74f5585d1
parent 6049 f0ae98fa85a1
permissions -rw-r--r--
[debian] build the book with no auto-compression of book files (closes: #1906581) Book content paths (html and rest) are now excluded from Debian compression step. This will fix a documentation search issue on the website (doc.cubicweb.org) Documentation build is now made optional since it can break for old distributions and we don't want to block a new release of Cubicweb because of documentation issues.

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