Changes between Version 1 and Version 2 of DocDéveloppeur
- Timestamp:
- 07/24/08 17:30:32 (16 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
DocDéveloppeur
v1 v2 1 1 ---- 2 '''Documentation Développeur''' [[BR]] 3 Date 2 '''''Documentation Développeur''''' 3 4 '''Auteurs''' : Sébastien Denvil, Martial Mancip, Patrick Brockmann [[BR]] 4 5 ---- 5 Auteurs : Sébastien Denvil, Martial Mancip, Patrick Brockmann [[BR]] 6 7 '''Sommaire général''' [wiki:WikiStart libIGCM] 8 [[PageOutline(1-2,Table des matières,inline)]] 6 9 7 10 ---- 8 '''Sommaire générale''' [[BR]] 9 10 [wiki:WikiStart] 11 12 ---- 13 '''Sommaire''' 14 TableOfContents(2) 15 16 ---- 17 == Stratégies de développement == 11 12 = Stratégies de développement = 18 13 * Développer le plus clairement possible 19 14 * S'appuyer sur des commandes UNIX avec des options standards 20 15 * Inclure une documentation dans le code 21 {{{ 16 17 {{{ 22 18 #================================================== 23 19 # The documentation of this file can be automatically generated … … 27 23 #D-This line will be extracted 28 24 #D-This one too 29 25 }}} 30 26 * Fournir une fonction de test pour chaque librairie. Le test se réalise en faisant la différence entre les résulats courants et un fichier de résultats de référence. 31 {{{ 27 28 {{{ 32 29 Check libIGCM_debug ..........................................[ FAILED ] 33 34 35 36 Check libIGCM_debug ............................................ [ OK ]30 }}} 31 Indique que la librairie libIGCM_debug n'est pas opérationnelle. 32 {{{ 33 Check libIGCM_debug ..............................................[ OK ] 37 34 Check libIGCM_card ...............................................[ OK ] 38 35 Check libIGCM_date ...............................................[ OK ] 39 ... 40 }}} 41 Indique que toutes ces librairies sont opérationnelles. 42 43 == Règles de syntaxe == 36 }}} 37 Indique que toutes ces librairies sont opérationnelles. 38 39 = Règles de syntaxe = 44 40 * Les noms des variables sont définies sans espace avec des majuscules : 45 41 * ceciestunevariable <-- incorrect 46 42 * !CeciEstUneVariable <-- correct 47 43 48 = = libIGCM_card ==44 = libIGCM_card = 49 45 50 46 Cette librairie se charge de faire la lecture et l'écriture dans les fichiers 51 47 carte. 52 48 53 == = Description du format card ===49 == Description du format card == 54 50 55 51 Ce paragraphe décrit les éléments du format d'un fichier CARD (inspiré du format INI): 56 52 57 * Sections: Les sections commencent par ' [' et se termine par ']' comme pour les sections [Messages] et [Recipes] utilisées dans l'exemple ci-dessous.53 * Sections: Les sections commencent par ''['' et se termine par '']'' comme pour les sections [Messages] et [Recipes] utilisées dans l'exemple ci-dessous. 58 54 59 55 * Options: L'option ''Red = 120'' ci-dessous est un exemple d'option (aussi connu sous le nom de clé). Les options commencent par une clé ''Red'', suivie du signe égale '=', et elles se terminent par une valeur ''120''. 60 56 61 * Commentaires: Toutes les lignes commen cant par un '#' sont considérées comme étant des commentaires, et sont ignorées.62 63 * Continuation de lignes: Une option peut etre écrite sur plusieurs lignes si le dernier caractère de la ligne est un '\'57 * Commentaires: Toutes les lignes commençant par un '#' sont considérées comme étant des commentaires, et sont ignorées. 58 59 * Continuation de lignes: Une option peut être écrite sur plusieurs lignes si le dernier caractère de la ligne est un '\' 64 60 65 61 * Exemple: 66 {{{ 62 63 {{{ 67 64 [Messages] 68 65 Option1= "Hello Earth" … … 85 82 (far, close) 86 83 List2= (ice, fire, air, water) 87 }}} 88 89 === Documentation interne === 84 }}} 85 86 == Documentation interne == 87 90 88 {{{ 91 89 #==================================================================
