developer.jelix.org is not used any more and exists only for history. Post new tickets on the Github account.
developer.jelix.org n'est plus utilisée, et existe uniquement pour son historique. Postez les nouveaux tickets sur le compte github.

Changes between Initial Version and Version 1 of en/codingstyle


Ignore:
Timestamp:
Oct 29, 2007, 2:30:42 PM (14 years ago)
Author:
doubleface
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • en/codingstyle

    v1 v1  
     1= Coding style =
     2
     3== Editor's setting ==
     4
     5Here are the rules you must respect while editing sources of jelix :
     6
     7 * encoding used in the sources is UTF-8 (since svn 386)
     8 * for indent, 4 space characters are used (no tab character)
     9
     10== Creating a new file ==
     11
     12You must add a header in the PHP source :
     13
     14{{{
     15/**
     16* @package     package
     17* @subpackage  sub-package
     18* @author      your name
     19* @contributor
     20* @copyright   2007 your name
     21* @link        http://www.jelix.org
     22* @licence     GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html
     23*/
     24}}}
     25
     26Package in general is jelix. Sub-package, for jelix, it is the name of the directory in lib/jelix.
     27
     28You have to specify your name on the @author line and the copyright on the @copyright line.
     29
     30The license for the jelix files must be LGPL. For jelix-scripts, it's GPL. For the modules, this is your choice.
     31
     32== Modifying the existing sources ==
     33
     34For the files you modify but you didn't creqte, you can specify your name in the header :
     35
     36 * in the @contributor line
     37 * add a @copyright line with your copyright.
     38
     39Of course, modifying an existing file implies that you accept that your modifications will be published under the specified license in the header.
     40
     41== The code ==
     42
     43The code must be the most powerfull and light that is possible for you. It must be usable as easy as possible.
     44
     45
     46
     47----
     48[/wiki/en Back to summary]