doc/coding_standards_js.rst
author Quentin Roquefort <roquefort.quentin@gmail.com>
Thu, 28 Apr 2011 20:41:44 +0200
changeset 7277 acd7f0e9f276
parent 6049 f0ae98fa85a1
permissions -rw-r--r--
[etwist] Generates apache's mod_concat-like urls for js and css Uses the lists of js, css and ie_css included in order to generate urls compatible with Apache mod_concat (ie: http://test.fr/??file1.js,file2.js). Css files may use `media` option or may be for IE only ; this patch does not concatenate css filenames for different media types or different IE specs. It concatenates only files served under cubicweb's `data` urls and keeps original include order. The generated urls are added to the HTML header as usual. HOW-TO: - calling HTMLHead(datadir_url) will enable the url concatenation - calling HTMLHead() will not benefit of url concatenation IMPORTANT NOTE: - fckeditor can no more be served under `/data/` segment

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