Notes d'étude Python - rédaction de documents d'aide pour des classes ou des fonctions personnalisées et réalisation de tests de documents

En python, on peut utiliser help("module name") ou help(class name) pour afficher la documentation d'une classe ou d'une fonction. Mais comment sont-ils écrits ? En fait, ils utilisent """ trois guillemets doubles pour envelopper plusieurs lignes de commentaires au début du cours ou de la méthode. Ces contenus seront considérés comme des documents d'aide par Python.

Quel contenu le document d'aide comprend-il généralement ? 🎜>Valeurs entrantes et valeurs de sortie

Instructions pour certains cas particuliers

Contenu du test du document

Ce qui précède est un résumé personnel, mais je n'ai vu aucune information pertinente

<.>

Donnons un exemple :

Saisie dans un terminal python

Utiliser doctest pour les tests de documents

Nous pouvons également utiliser le module doctest pour les tests de documents dans les commentaires 🎜>

class Apple(object):
""" This is an Apple Class"""
def get_color(self):
"""
Get the Color of Apple.
get_color(self) -> str
"""
return "red"

Par exemple, après avoir ajouté le contenu du test de documents, cela ressemble à ceci :

>>> from CallDemo import Apple
>>> help(Apple)
Help on class Apple in module CallDemo:
class Apple(__builtin__.object)
| This is an Apple Class
| 
 | Methods defined here:
| 
 | get_color(self)
| Get the Color of Apple.
| get_color(self) -> str
| 
 | ----------------------------------------------------------------------
| Data descriptors defined here:
| 
 | __dict__
| dictionary for instance variables (if defined)
| 
 | __weakref__
| list of weak references to the object (if defined)

doctest. .testmod()

Depuis que nous avons écrit

, le test du document ci-dessus ne sera effectué que lorsqu'il est exécuté avec le fichier d'entrée, donc le test du document ne sera pas effectué dans applications réelles. 🎜>

Ce qui précède sont les notes d'étude de Python - rédaction de documents d'aide pour des classes ou des fonctions personnalisées et tests de documents. Pour plus de contenu connexe, veuillez prêter attention au site Web PHP chinois (www.php. cn)!>

class Apple(object):
"""
This is an Apple Class
Example:
>>> apple = Apple()
>>> apple.get_color()
'red'
>>> apple.set_count(20)
>>> apple.get_count()
400
"""
def get_color(self):
"""
Get the Color of Apple.
get_color(self) -> str
"""
return "red"
def set_count(self, count):
self._count = count
def get_count(self):
return self._count * self._countif __name__ == '__main__':
import doctest