Comment puis-je me documenter un module en Python?

Question

C'est tout. Si vous souhaitez documenter une fonction ou d'une classe, vous mettre une chaîne juste après la définition. Par exemple:

def foo():
    """This function does nothing."""
    pass

Mais que penser d'un module? Comment puis-je ce qu'est un document file.py n'?

Answer 1

Ajouter votre docstring que la première instruction dans le module.

Depuis j'aime voir un exemple:

"""
Your module's verbose yet thorough docstring.
"""

import foo

# ...

Answer 2

Pour les paquets, vous pouvez le document en __init__.py. Pour les modules, vous pouvez ajouter une docstring simplement dans le fichier module.

Toutes les informations sont ici: http://www.python.org/dev/peps/pep-0257/

Answer 3

Vous le faire exactement de la même manière. Mettre une chaîne dans la première instruction dans le module.

Answer 4

C'est facile, il suffit d'ajouter une docstring en haut du module.