doc/coding_standards_js.rst
author Pierre-Yves David <pierre-yves.david@logilab.fr>
Wed, 11 Apr 2012 13:28:10 +0200
changeset 8363 3f3b4e4c63f5
parent 6049 f0ae98fa85a1
permissions -rw-r--r--
[devtool-testlib] add deprecated entry point for publish method 6c2119509fac renamed ``publish`` to ``handle_request``. And removed the older testlib function (because the semantic of handle_request is quite different from the publish one). However it seems to do more harm that good and I'm adding proxy with deprecation warning for those.

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