Bonjour à tous.
Je propose ce petit post sans prétentions afin d'expliquer un truc assez utile pour les développeurs de scripts qui veulent faire facilement une documentation de leur code.
Pour générer une doc assez simplement, la première chose à faire, est de bien documenter le script lui même.
(Python):
"""Ce script fait ceci cela, pour le lancer faites ceci cela
puis vous pouvez faire cela et cela.
Pour me contacter, mailez moi"""
def mafonction():
"""Fonction qui renvoie un truc.
le truc renvoyé est une chaine"""
def maclasse:
"""classe qui sert à ca"""
def __init__(self,*args,**kwargs):
"""Initialisation de la classe.
Il faut passer le parametre machin"""
#ETC....
Ensuite, vous avez une très simple fonction qui vous permet d'obtenir la documentation du script :
(Python):
import test
print help(test)
Help on module test:
NAME
test
FILE
test.py
CLASSES
maclasse
class maclasse
| classe qui sert à ca
|
| Methods defined here:
|
| __init__(self, *args, **kwargs)
| Initialisation de la classe.
| Il faut passer le parametre machin
FUNCTIONS
mafonction()
Fonction qui renvoie un truc.
le truc renvoyé est une chaine
Cette soution est la plus simpliste. Mais elle permet déjà d'avoir de bonnes informations.
Une autre librairie de python est pydoc dont je vous laisse le soin d'en chercher de la doc sur internet.
Il existe apparemment d'autres librairies mieux faites enore que pydoc mais que je n'ai pas eut l'occasion de tester.
J'espère que cela vous sera utile à l'occasion :)
