Python-Studiennotizen – Schreiben von Hilfedokumenten für benutzerdefinierte Klassen oder Funktionen und Durchführen von Dokumenttests

In Python können wir help("Modulname") oder help(Klassenname) verwenden, um die Dokumentation einer Klasse oder Funktion anzuzeigen. Aber wie werden sie geschrieben? Tatsächlich verwenden sie drei doppelte Anführungszeichen „“, um mehrere Kommentarzeilen am Anfang der Klasse oder Methode einzuschließen. Diese Inhalte werden von Python als Hilfedokumente betrachtet.

Welche Inhalte enthält das Hilfedokument normalerweise? 🎜>Eingehende Werte und Ausgabewerte

Anweisungen für einige Sonderfälle

Inhalt des Dokumenttests

Der obige Inhalt ist eine persönliche Zusammenfassung, aber ich habe keine relevanten Informationen gesehen

Lassen Sie uns ein Beispiel geben:

Geben Sie im Python-Terminal ein

Verwenden Sie doctest zum Testen von Dokumenten

Wir können auch verwenden das doctest-Modul für Dokumententests in den Kommentaren 🎜>

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

Nachdem wir den Dokumenttestinhalt hinzugefügt haben, sieht es beispielsweise so aus:

>>> 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()

Da wir

geschrieben haben, wird der obige Dokumenttest nur durchgeführt, wenn er mit der Eingabedatei ausgeführt wird, sodass der Dokumenttest nicht durchgeführt wird Aktuelle Anwendungen. 🎜>

Das Obige sind die Python-Studiennotizen – Schreiben von Hilfedokumenten für benutzerdefinierte Klassen oder Funktionen und Dokumenttests. Weitere verwandte Inhalte finden Sie auf der chinesischen PHP-Website (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