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.
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
- Timestamp:
- Jun 22, 2009, 3:22:49 PM (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
en/doc-guidelines
v5 v6 17 17 18 18 === Function names === 19 To specify a function name inside a paragraph, surround it with **. This will make the function name bold, andcatch the eye easier.19 To specify a function name inside a paragraph, add @@M@ before and @@ after. This will make the function name catch the eye easier. 20 20 {{{ 21 **jelixClass::function** 22 **function**of the jelixClass21 @@M@jelixClass::function@@ 22 @@M@function@@ of the jelixClass 23 23 }}} 24 24 25 25 === Jelix terms === 26 All Jelix-specific terms should be in italics. This will separate generic terms from Jelix-specific terms. Surround the terms with //.26 All Jelix-specific terms or components name inside text should stand out a bit. Therefore, they should be surrounded by @@ before and @@ after. 27 27 {{{ 28 //jelix term// 28 @@jelix term@@ 29 }}} 30 31 === User defined/redefined component === 32 Any 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@@ 29 35 }}} 30 36 … … 54 60 * Use clear variable names. Instead of using a variable called $x, use on called $numberOfResultProcessed. 55 61 * 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.'''