search

Aluminium95 / PyMastermind

Isn terminale mastermind
1 stars 1 forks source link

Thomas commente #5

Closed Aluminium95 closed 11 years ago

Aluminium95 commented 11 years ago

Commenter moteur.py de façon lisible ... Et générer la doc automatique pour son module

Aluminium95 commented 11 years ago

Thomas, j'ai regardé la manière dont tu documentes, c'est un peu nul ...

def ma_fonction (arg1, arg2):
   """ courte description ici sur une seule ou deux lignes 

      @arg1 : type = description 
      @arg2 : type = description 

      @return : type [=description en option ...]
   """

Des description comme celle-ci permettent de générer automatiquement de la doc :-)

Aluminium95 commented 11 years ago

J'ai fait une grande partie du travail ! Il est maintenant possible d'avancer sur le chemin de la grandeur, mais j'ai converti toutes les lignes de commentaire utiles en description de fonction pour pydoc :-p