web-dev-qa-db-fra.com

Comment écrire du texte d'aide / description pour les fonctions Python

J'ai récemment commencé à programmer en utilisant Python. Je dois écrire de nombreuses fonctions et je me demandais comment incorporer un texte d'aide ou de description tel qu'il apparaisse dans l'inspecteur d'objets de spyder lorsque j'appelle la fonction. Dans MatLab, cela fonctionnait en mettant du texte commenté au début du fichier de fonction. Existe-t-il une méthode similaire dans Python (en utilisant Spyder)?

pythonfunctionspyder
13
user1984653

Par défaut, la première chaîne dans le corps d'une méthode est utilisée comme docstring (ou chaîne de documentation). Python l'utilisera lorsque help() est appelée pour cette méthode.

def foo(bar):
    ''' Takes bar and does
        some things to it '''
    return bar

help(foo)
foo(bar)
    Takes bar and does
    some things to it

Vous pouvez en savoir plus sur la façon dont cela fonctionne en lisant PEP-258 , et cette question donne plus de détails.

28
Burhan Khalid

( Mainteneur de Spyder ici ) Il y a d'autres choses que vous devez savoir (en plus de ce que @ burhan-khalid a mentionné) concernant Spyder lui-même:

  1. Si vous voulez voir vos docstrings bien formatés dans le volet d'aide, vous devez les écrire en suivant la norme numpydoc, qui est expliquée ici . Il s'agit d'un ensemble de conventions utilisées par presque tous les packages scientifiques python pour écrire leurs docstrings. Ce n'est pas obligatoire mais nous le suivons également lors de la conversion de docstrings (qui viennent en texte brut) en html.

  2. Vous devez utiliser Ctrl+I devant le nom d'un objet pour afficher son aide dans notre volet d'aide.

8
Carlos Cordoba