Présentation de code correcte ?Résolu

Question

Bonjour à tous,
J'ai découvert le Python il y a trés peu de temps, je programme depuis 9 mois en ruby, et je me suis essayé à se language qui m'impressionne beaucoup.

Maintenant j'ai pris des habitude sur le ruby, sur sa syntaxe, et j'ai une manière bien à moi de commenter.

Je voudrais savoir si cette manière de commenter conviens dans ce language.

Voici un petit code que j'ai créé pour m'initier à la syntaxe ed ce language :
#======================================
# Méthode - paire
#--------------------------------------
# Créé par Corbaque le 30/09/2006
#--------------------------------------
# Fonction :
# Sert à savoir si le nombre "x" est
# paire
#--------------------------------------
# Action :
# Renvoi une chaine de caractère
#--------------------------------------
# Fonctionnement :
# Vas diviser le nombre x par 2.0,
# ainsi un résulat de type Float est
# généré
# - si le nombre est paire, le
#   résultat auras une partie
#   décimale nulle
# - si le nombre est impaire, le
#   résultat auras 5 pour en partie
#   décimale
# Il compare ce résultat
# au même calcul arrondi à l'entier
# le plus proche.
# - que le nombre sois paire ou
#   impaire, le résultat auras une
#   partie décimale nulle
# En conclusion si le nombre est paire
# les deux quotients sont égaux, et
# inversement
#--------------------------------------
# Extra :
# La réciproque est intégrée
#======================================
def paire(x):
    # Compare la moitiée de x à son homologue arrondi à l'entier
    if x / 2.0 == int(x/2.0):
        # S'ils sont égaux renvoyer "oui"
        return "oui"
    else:
        # Dans le cas contraire renvoyer "non"
        return "non"
#--------------------------------------    
# Réciproque de la méthode précédente
#-------------------------------------- 
def impaire(x):
    # Compare la moitiée de x à son homologue arrondi à l'entier
    if x / 2.0 == int(x/2.0):
         # S'ils sont égaux renvoyer "non"
        return "non"
    else:
        # Dans le cas contraire renvoyer "oui"
        return "oui"
#======================================
# Exemple d'utilisation des méthodes
# ci-dessus
#======================================
# i est un entier égal à 0
i = 0
# Tant que i est inferieur à 21
while i < 21:
    # Afficher i, s'il est paire, s'il est impaire
    print i, "=> paire :", paire(i), "| impaire :", impaire(i)
    # Auguementer i de 1
    i += 1

Merci beaucoup de votre interet.

econs · Accepted Answer

Salut,

Disons que tant que çà s'exécute, tu peux commenter comme tu veux. Il n'y a pas de règle tant que le code reste lisible. Ici, c'est le cas.

Si tu as pris l'habitude de commenter autant, tant mieux pour ceux qui te lisent. 




Manu


--------------------------------------------------------------------------------------------
Avant de poster un message, n'oubliez pas de consulter le reglement.

cs_corbaque · Answer

Merci bien, on ne sais jamais à quoi s'attendre ^^

Voila mon code plus que légèrement optimisé :
#======================================
# Méthode - paire
#--------------------------------------
# Créé par Corbaque le 30/09/2006
#--------------------------------------
# Fonction :
# Sert à savoir si le nombre "x" est
# paire
#--------------------------------------
# Action :
# Renvoi une chaine de caractère
#--------------------------------------
# Fonctionnement :
# Exerce une division euclidienne sur
# Le nombre x par 2
# - Si le reste est nul,
#   Le nombre est divisible par 2
#   Il est donc paire
# - Si le reste n'est pas nul,
#   Le nombre n'est pas divisible par 2
#   Il est donc impaire
#--------------------------------------
# Extra :
# La réciproque est intégrée
#======================================
def paire(x):
    # Vérifie que x est un nombre entier
    if int(x) == x:
        # Exerce une division euclidienne sur x par 2
        if x % 2 == 0:
            # Si le reste est nul le nombre est paire, renvoyer "oui"
            return "oui"
        else:
            # Si le reste n'est pas nul le nombre est impaire, renvoyer "non"
            return "non"
    else:
        # Si x n'est pas un entier, afficher un message d'erreur
        print "Le nombre doit être un entier !"
        return "Error"
#--------------------------------------    
# Réciproque de la méthode précédente
#-------------------------------------- 
def impaire(x):
    # Vérifie que x est un nombre entier
    if int(x) == x:
        # Exerce une division euclidienne sur x par 2
        if x % 2 == 0:
            # Si le reste est nul le nombre est paire, renvoyer "non"
            return "non"
        else:
            # Si le reste n'est pas nul le nombre est impaire, renvoyer "oui"
            return "oui"
    else:
        # Si x n'est pas un entier, afficher un message d'erreur
        print "Le nombre doit être un entier !"
        return "Error"
#======================================
# Exemple d'utilisation des méthodes
# Ci-dessus
#======================================
# i est un entier égal à 0
i = 0.0
# Tant que i est inferieur à 21
while i < 51:
    # Afficher i, s'il est paire, s'il est impaire
    print i, "=> paire :", paire(i), "| impaire :", impaire(i)
    # Auguementer i de 1
    i += 1.5
input()

Bon bien sur l'interet est inexistant, c'est d'ailleur pour cela que je ne l'ai pas posté comme tutoriel :P

Présentation de code correcte ?

2 réponses

Votre réponse

Discussions similaires