Phenquestions
Voorbeeld-1: Toegang tot docstring van een functie met behulp van __doc__ attribuut
De manier om de docstring van een aangepaste functie te declareren en te openen, is weergegeven in het volgende script:. Het volgende script berekent de xnee waarbij x en n worden overgenomen van de gebruiker. Vermogen () functie heeft gedefinieerd in het script om de taak uit te voeren. Hier is de docstring gedefinieerd voor deze functie. __doc__ attribuut is in het script gebruikt om de docstring met de uitvoer af te drukken.
def macht (x, n):"Bereken x tot de macht n
Lees de waarden van x en n uit de functieargumenten
en Bereken en retourneer de waarde van x tot de macht n."
retour x**n
# Neem de waarde van x
x = int(input('Vul de waarde van x:'))
# Neem de waarde van n
n = int(input('Vul de waarde van n:'))
# Druk de retourwaarde van de functie af
print("De %d tot de macht %d = %d" %(x, n, macht(x, n)))
# Druk de docstring-waarde af
print("De inhoud van de docstring:\n" + power.__doc__)
Uitgang:
De volgende uitvoer zal verschijnen na het uitvoeren van het bovenstaande script:.
Voorbeeld-2: Toegang tot docstring van klasse en methode met behulp van helpen() methode
De manier om de docstring van het document en de methoden van die klasse te declareren en te openen, is weergegeven in het volgende script. De hoofdfunctie van het script is om een numerieke lijst te sorteren en de gegevens van de lijst om te keren. Een numerieke lijst van 8 elementen is gedeclareerd in de klasse en de docstring is gedefinieerd aan het begin van de klasse met behulp van drievoudige enkele aanhalingstekens. De methode sort_list() is gedefinieerd in de klasse om de gesorteerde gegevens van de lijst af te drukken, en het document heeft dit gedefinieerd voor deze methode:. reverse_list() methode is gedefinieerd om de omgekeerde gegevens van de lijst af te drukken, en de docstring is ook gedefinieerd voor deze methode. helpen() methode heeft drie keer aangeroepen aan het einde van het script om de docstring van de . af te drukken list_operations klasse, sort_list() methode, en de reverse_list() methode.
class list_operations:
class list_operations:"
De lijstgegevens sorteren en omkeren
De klasse bevat twee methoden:,
sort_list() methode zal de lijst sorteren en afdrukken,
sort_reverse() methode zal de lijst omkeren en afdrukken.
"
# Definieer een lijst met numerieke gegevens
lijstgegevens = [23, 67, 23, 6, 45, 3, 90, 11]
def sort_list(zelf):
"
Print de lijstwaarden na het sorteren
De functie neemt een lijstobject met numerieke gegevens uit het argument,
sorteer de lijstwaarden met de methode sort()(
en print de waarden van de gesorteerde lijst.
"
# Sorteer de lijst
zelf.lijstgegevens.soort()
# Druk de gesorteerde lijst af met loop
print("De waarden van de gesorteerde lijst:\n")
voor waarde in jezelf.lijstgegevens:
print(waarde, " ", end=")
def reverse_list(zelf):
"
Print de lijstwaarden na het achteruitrijden
De functie neemt een lijstobject met numerieke gegevens uit het argument,
keer de lijstwaarden om met de methode reverse()
en print de waarden van de omgekeerde lijst.
"
# Keer de lijst om
zelf.lijstgegevens.omgekeerde()
# Druk de omgekeerde lijst af met loop
print("De waarden van de gesorteerde lijst:\n")
voor waarde in jezelf.lijstgegevens:
print(waarde, " ", end=")
# Druk de docstring-waarde van de klasse af
help(list_operations)
# Maak een object van de klasse
obj = lijst_operaties()
# Druk de docstring-waarde van de specifieke methode af
hulp (obj.sort_list)
# Roep de methode aan om de gesorteerde lijst af te drukken
obj.sort_list()
Uitgang:
De volgende uitvoer zal verschijnen na het uitvoeren van het script:. Alle docstring van het script is voor het eerst afgedrukt helpen() functie. De docstring van de sort_list() methode is afgedrukt voor de tweede helpen() functie.
Voorbeeld-3: Toegang tot docstring van de ingebouwde Python-module
In de vorige voorbeelden heeft de docstring gebruikt in door de gebruiker gedefinieerde klasse en functie. Elke ingebouwde Python-module en -klasse heeft zijn docstring die het doel van het gebruik van die specifieke module of functie verklaart. De codeur van de module of functie definieert de docstring om de code begrijpelijk te maken voor de gebruikers. Het volgende script zal de vooraf gedefinieerde docstring van de datetime-module afdrukken met behulp van de helpen() functie.
# Datum/tijd-module importerendatum/tijd importeren
# Toon de docstring van datetime
help(datum/tijd)
Uitgang:
De volgende uitvoer zal verschijnen na het uitvoeren van het script:. De docstring van de datetime-module toont de gedetailleerde documentatie ervan om de anderen te helpen de functies van de klassen en methoden die in deze module zijn gedefinieerd goed te kennen.
Conclusie:
De juiste documentatie is essentieel wanneer een module of functie wordt geïmplementeerd voor het specifieke doel om de andere codeur te helpen de module in hun code te gebruiken om de specifieke taak uit te voeren. Als de documentatie niet goed is gedefinieerd voor de module of functie, zullen de andere gebruikers problemen ondervinden bij het gebruik ervan. Elke codeur moet dus de docstring van het document gebruiken om gedetailleerde informatie te verstrekken zodat de anderen de code kunnen begrijpen.
