Conventions syntaxiques - Historique des versions

JahOne : /* Commentaire et chaîne de caractères */

2014-11-13T16:34:47Z

‎Commentaire et chaîne de caractères

Dionisos : /* introduction */

2014-10-20T07:38:49Z

‎introduction

Bogeurdan : /* Indentation et espaces */

2014-08-01T12:54:24Z

‎Indentation et espaces

Bogeurdan : /* Indentation et espaces */

2014-08-01T12:53:31Z

‎Indentation et espaces

Bogeurdan : /* Forme du code */

2014-08-01T12:52:17Z

‎Forme du code

Bogeurdan : /* Classes */

2014-08-01T10:53:25Z

‎Classes

Bogeurdan le 1 août 2014 à 10:52

2014-08-01T10:52:55Z

Youna : /* introduction */

2014-07-25T21:05:51Z

‎introduction

Youna : /* Convention de nommage */

2014-07-25T21:03:56Z

‎Convention de nommage

Youna le 25 juillet 2014 à 21:01

2014-07-25T21:01:54Z

@@ Ligne 130 : / Ligne 130 : @@
 ==Commentaire et chaîne de caractères==
 '''Commentaire'''
-Les docstring devront être précéder de ###
+Les docstrings devront être précédé de """ et finir par """
 Les chaîne de caractère seront délimiter par des " pas par des '.

@@ Ligne 4 : / Ligne 4 : @@
 Le choix du langage de programmation s'est tourné vers le '''python'''.
-De plus vue la portée internationale d'un tel projet la totalité de la programmation sera en '''anglais''' (commentaires compris).
+De plus, vue la portée internationale d'un tel projet la totalité de la programmation sera en '''anglais''' (commentaires compris).
 Les conventions adoptées qui suivent sont très largement inspirées des recommandations issues du site de python. Ces recommandations sont proposées au travers de PEP (Python Enhancement Proposal : proposition d'amélioration de Python). Pour toute zone de flou, n'hésitez pas à vous y référer et à enrichir ce wiki.

@@ Ligne 99 : / Ligne 99 : @@
 Au sein du code les espaces ne devrons pas apparaitre:
--au cœur des parenthèse, accolade et crochets.
+*au cœur des parenthèse, accolade et crochets.
--devant une virgule, un point-virgule ou deux points.
+*devant une virgule, un point-virgule ou deux points.
--devant les parenthèses d'une liste de paramètres.
+*devant les parenthèses d'une liste de paramètres.
--plus d'un espaces pour aligner des affectations ou autre.
+*plus d'un espaces pour aligner des affectations ou autre.
--autour d'un signe = si c'est une valeur par défaut d'un paramètre ou d'un appel de paramètre.
+*autour d'un signe = si c'est une valeur par défaut d'un paramètre ou d'un appel de paramètre.
 Par contre ils devrons toujours apparaitre:
--avant et après tous les opérateurs (affectation, comparaison, booléens, arithmétique)
+*avant et après tous les opérateurs (affectation, comparaison, booléens, arithmétique)
 Exemple de code correctement écrit:

@@ Ligne 90 : / Ligne 90 : @@
 ===Indentation et espaces===
 '''Indentation'''
-*''Indentation'' : utilisez 4 espaces par niveau d'indentation, ne jamais utiliser de tabulation.
 Pour faciliter l'écriture du code vous pouvez configurer votre logiciel d'écriture pour qu'il insérè 4 espaces quand vous appuyer sur la touche tabulation, ainsi vous ne pourrez pas faire d'erreur lors de l'écriture.
 Pour notepad vous pouvez avoir accès à cette fonction dans: Paramétrage / Préférence... / Tabulation.
@@ Ligne 96 : / Ligne 97 : @@
 '''Espaces'''
 Au sein du code les espaces ne devrons pas apparaitre:
 -au cœur des parenthèse, accolade et crochets.

@@ Ligne 88 : / Ligne 88 : @@
 ==Forme du code==
-*''Indentation'' : utilisez 4 espaces par niveau d'indentation.
+===Indentation et espaces===
-*Toujours utiliser des ''espaces'', jamais de tabulation.
+'''Indentation'''
 *Longueur maximum d'une ligne : limitez vos lignes à un maximum de 79 caractères. Pour les blocs de texte relativement longs (docstrings, par exemple), limitez-vous de préférence à 72 caractères par ligne.
 *Découpez vos lignes en utilisant des parenthèses, crochets ou accolades plutôt que l'anti-slash \.

@@ Ligne 76 : / Ligne 76 : @@
 ===Classes===
-Les classes seront écrites avec en PascalCase:
+Les classes seront écrites en PascalCase:
   class NomDeClasse

@@ Ligne 54 : / Ligne 54 : @@
 En plus d'une meilleure lisibilité, d'une collaboration plus efficace entre les programmeurs, il apparait qu'un intérêt d'adopter une convention de nommage peut être la vérification simplifiée du programme en vue d'une meilleure sécurité voir EAL [http://fr.wikipedia.org/wiki/Convention_de_nommage] et [http://fr.wikipedia.org/wiki/Evaluation_Assurance_Level].
-===Variables, fonctions et méthodes===
+===Variables, fonctions, méthodes et arguments===
 Le nom est entièrement écrit en minuscules et les mots sont séparés par des signes soulignés (_).
-  nom_de_fonction.
+  nom_de_fonction
 ===Constantes===
 Les constantes doivent être écrites entièrement en majuscules, les mots étant séparés par un signe souligné (_).
-  NOM_DE_MA_CONSTANTE.
+  NOM_DE_MA_CONSTANTE
-−
-===Arguments===
 ===Modules===
 ===Classes===
-==Régles d'écriture==
+==Règles d'écriture==
 Il y a deux bonnes raisons de ne pas respecter une règle donnée :
@@ Ligne 87 : / Ligne 96 : @@
     parametre_3, parametre_4):
 ...
 *Si vous devez découper une ligne trop longue, faites la césure après l'opérateur, pas avant.
 # Oui
    un_long_calcul = variable + \
            taux * 100
-−
-# Non
-   un_long_calcul = variable \
-           + taux * 100

@@ Ligne 1 : / Ligne 1 : @@
 ==introduction==
-Cette page à pour vocation de rassembler les différentes règles de rédaction du programme ESM. Étant donnée le nombre important de collaborateurs attendu pour l'élaboration de ce programme il convient de s'accorder au préalable sur une même façon de coder.
+Cette page à pour vocation de rassembler les différentes règles de rédaction du programme ESM. Étant donné le nombre important de collaborateurs attendus pour l'élaboration de ce programme il convient de s'accorder au préalable sur une même façon de coder.
-Le choix du langage de programmation c'est tourné vers le '''python'''.
+Le choix du langage de programmation s'est tourné vers le '''python'''.
-De plus vue la porté internationale d'un tel projet la totalité de la programmation sera en '''anglais''' (commentaires compris).
+De plus vue la portée internationale d'un tel projet la totalité de la programmation sera en '''anglais''' (commentaires compris).
-Les conventions adoptées qui suivent sont très largement inspirées des recommandations issue du site de python. Ces recommandations sont proposées au travers de PEP (Python Enhancement Proposal : proposition d'amélioration de Python). Pour toute zone de flou, n'hésitez pas à vous y référer et à enrichir ce wiki.
+Les conventions adoptées qui suivent sont très largement inspirées des recommandations issues du site de python. Ces recommandations sont proposées au travers de PEP (Python Enhancement Proposal : proposition d'amélioration de Python). Pour toute zone de flou, n'hésitez pas à vous y référer et à enrichir ce wiki.
 ==Conseil généraux==

@@ Ligne 52 : / Ligne 52 : @@
 ==Convention de nommage==
-En plus d'une meilleure lisibilité, d'une collaboration plus efficace entre les programmeurs, il apparait qu'un intérêt d'adopter une convention de nomage peut être la vérification simplifié du programme en vue d'une meilleure sécurité voir EAL [http://fr.wikipedia.org/wiki/Convention_de_nommage] et [http://fr.wikipedia.org/wiki/Evaluation_Assurance_Level].
+En plus d'une meilleure lisibilité, d'une collaboration plus efficace entre les programmeurs, il apparait qu'un intérêt d'adopter une convention de nommage peut être la vérification simplifiée du programme en vue d'une meilleure sécurité voir EAL [http://fr.wikipedia.org/wiki/Convention_de_nommage] et [http://fr.wikipedia.org/wiki/Evaluation_Assurance_Level].
 ===Variables, fonctions et méthodes===