L'objectif : Dans le cadre d'un projet Python, nous souhaitons documenter proprement de code.
Comme exemple nous considérerons que nous avons codé une classe Sample dans sample.py :
01: class Sample:
02: """
03: Classe d'exemple pour Sphinx
04: """
05:
06: def __init__(self, name):
07: """
08: Constructeur de la classe
09:
10: :param name: Nom de l'objet
11: :type name: string
12:
13: :return: Objet Sample
14: :rtype: Sample
15: """
16: self.name = name
17:
18: def displayName(self):
19: """
20: Affiche le nom
21:
22: :return: None
23: :rtype: NoneType
24: """
25: print(self.name)
26:
27: def __changeName(self, newName):
28: """
29: Change le nom
30:
31: :param newName: Nouveau nom
32: :type newName: string
33:
34: :return: None
35: :rtype: NoneType
36: """
37: self.name =...
- Accédez à tous les contenus de Connect en illimité
- Découvrez des listes de lecture et des contenus Premium
- Consultez les nouveaux articles en avant-première