doc/dev/coding_standards_js.rst
author Laurent Peuch <cortex@worlddomination.be>
Tue, 12 Mar 2019 11:40:59 +0100
changeset 12492 a7ffcaae7f4c
parent 12370 b3084ae2e718
permissions -rw-r--r--
[doc/changelog] the removal of next_tabindex produce an error not in the changelog When one tried to migrate to 3.25, the error "class X initialization doesn't have a settabindex argument" can happen but the word "settabindex" is not present in the changelog which makes it hard to find to which modification this error is related.

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

(Draft, to be continued)

:Naming: camelCase, except for CONSTANTS

Indentation rules
~~~~~~~~~~~~~~~~~

- one space before an opening curly bracket ({)

- line break after a closing curly bracket (}) (possibly no line break if
  everything is on the same line)

- 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