+ documentation

projet poo.py

@@ -2,6 +2,7 @@ from random import randint
 
 class Personnage :
     def __init__(self, nom, cat) :
+        """initialisation des attributs de la classe Personnage"""
         self.nom = nom
         self.cat = cat.lower()
         self.pv = 20
@@ -16,6 +17,7 @@ class Personnage :
             self.inv = ["arc","potion"]
     
     def jet_attaque(self) :
+        """fonction permettant de faire un jet de dé d'attaque"""
         resultat_de = randint(1, 20)
         if self.cat == "guerrier" or self.cat == "magicien" :
             return resultat_de+self.exp*10
@@ -25,6 +27,7 @@ class Personnage :
             return resultat_de+self.exp*8
     
     def jet_defense(self) :
+        """fonction permettant de faire un jet de dé de défense"""
         resultat_de = randint(1,20)
         if self.cat == "guerrier" :
             return resultat_de+self.exp*8
@@ -36,22 +39,27 @@ class Personnage :
             return resultat_de+self.exp*10
     
     def change_pv(self, nb_pv) :
+        """fonction permettant de changer les points de vie d'un personnage"""
         self.pv += nb_pv
         if self.pv < 0 :
             self.pv = 0
     
     def change_exp(self, nb_exp) :
+        """fonction permettant de changer l'expèrience d'un personnage"""
         self.exp += nb_exp
     
     def affiche_caracteristiques(self) :
+        """fonction permettant d'afficher les caractéristiques d'un personnage"""
         print(f"{self.nom} le {self.cat} a actuellement {self.pv} PV et {self.exp} EXP")
     
     def affiche_inventaire(self) :
+        """fonction permettant d'afficher l'inventaire d'un personnage"""
         print(f"Bonjour {self.nom}, voici ton inventaire :")
         for i in range(len(self.inv)) :
             print(f"- {self.inv[i]}")
 
 def combat() :
+    """fonction principale permettant de faire un combat entre 2 personnages"""
     perso1 = Personnage(input("Comment s'appelle le premier joueur ? "), input("Quelle est sa catégorie ? (guerrier, magicien, voleur, elfe) "))
     perso2 = Personnage(input("Comment s'appelle le second joueur ? "), input("Quelle est sa catégorie ? (guerrier, magicien, voleur, elfe) "))
     print()