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 Version 5 and Version 6 of en/doc-guidelines


Ignore:
Timestamp:
Jun 22, 2009, 3:22:49 PM (11 years ago)
Author:
afroxav
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • en/doc-guidelines

    v5 v6  
    1717
    1818=== Function names ===
    19 To specify a function name inside a paragraph, surround it with **. This will make the function name bold, and catch the eye easier.
     19To specify a function name inside a paragraph, add @@M@ before and @@ after. This will make the function name catch the eye easier.
    2020{{{
    21 **jelixClass::function**
    22 **function** of the jelixClass
     21@@M@jelixClass::function@@
     22@@M@function@@ of the jelixClass
    2323}}}
    2424
    2525=== Jelix terms ===
    26 All Jelix-specific terms should be in italics. This will separate generic terms from Jelix-specific terms. Surround the terms with //.
     26All Jelix-specific terms or components name inside text should stand out a bit. Therefore, they should be surrounded by @@ before and @@ after.
    2727{{{
    28 //jelix term//
     28@@jelix term@@
     29}}}
     30
     31=== User defined/redefined component ===
     32Any jelix component that is defined or redefined by the user inside the application should be surrounded by @@C@ before and @@ after. This does not include function names, which should always follow the function name guide.
     33{{{
     34@@C@user defined component@@
    2935}}}
    3036
     
    5460 * Use clear variable names. Instead of using a variable called $x, use on called $numberOfResultProcessed.
    5561 * Use !CamelCase. By enforcing a strict naming convention, code can be consistent.
     62
     63'''The current documentation guideline is frozen. Post any changes you might want to the forums and they will maybe be added.'''