doc/coding_standards_js.rst
author Pierre-Yves David <pierre-yves.david@logilab.fr>
Tue, 11 Oct 2011 16:01:44 +0200
branchstable
changeset 7939 e107204d3b27
parent 6049 f0ae98fa85a1
permissions -rw-r--r--
Add a hidden input:submit field in facets form (closes #1988784) <Enter> is supposed to submit the form only if there is a single input:text field. However most browsers will submit the form on <Enter> anyway if there is an input:submit field. see: http://www.w3.org/MarkUp/html-spec/html-spec_8.html#SEC8.2 Firefox 7.0.1 does not submit form on <Enter> if there is more than a input:text field and not input:submit but does it if there is an input:submit. IE 6 or Firefox 2 behave the same way.

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