Python DocString -eksempel

Python -dokumentasjonsstrenger, ofte kjent som Docstrings, er strenglitteraler som brukes i erklæringen om en modul, klasse, metode eller funksjon. Ethvert Python-objektets DOC-attributt (__doc__) samt Help () -funksjonens innebygde funksjonalitet, gir tilgang til DocStrings. Som den første setningen i objektets definisjon, definerer en strengkonstant objektets doktor. Python Docstrings er dekket i denne økten. Ved hjelp av flere eksempler vil vi oppdage den nøyaktige anvendelsen av Docstrings.

Mens kommentarene brukes til programmer, utsagn og uttrykk, som vanligvis er korte, er doktorer utmerkede for å forstå funksjonen til den større delen av skriptet som den generelle bruken av hvilken som helst modul, klasse eller funksjon. De er en beskrivelse av en kodelinje eller uttalelse produsert av en programmerer som vanligvis er for seg selv å forstå hva den gjør. Det er avgjørende å dokumentere koden din riktig hvis du vil skrive programmer med klar kode og god dokumentasjon. Docstrings leveres, bruker “Triple Single Quotes” eller “Triple Double Quotes” rett etter definisjonen av funksjon, klasse eller metode.

Eksempel 1: Program for Python DocString Triple Single Quotes

Enten objektets __doc__ -metode eller hjelpefunksjonen kan brukes til å oppnå dokumentene. Erklæringen og bruken av en DocString med de trippel enkelt sitatene vises i følgende eksempler:

Begynn med å definere en funksjon i Python. Vi lager en funksjon som my_func (). Innenfor My_func -kroppen har vi som en DocString pakket rundt de trippel enkelt sitatene. På slutten av funksjonen utfører vi eksplisitt returerklæringen som returnerer ingen verdi. Utskriftsfunksjonen tar my_func med _doc_ -objektet som viser doktoren. Videre har vi en Python Help -funksjon som brukes til å skrive ut dokumentasjonen av my_func -funksjonen.

Når dette spesielle programmet blir feilsøkt og kjørt, genererer det følgende resultater i konsollskjermen til Spyder:

Eksempel 2: Program for Python DocString Triple Double Quotes

Følgende kode distribuerer DocString-erklæringen og bruker med de trippel dobbeltkvotene:

Her gir vi et funksjonsnavn my_func2. Inne. Deretter kaller vi Pythons _DOC_ -objekt for å skrive ut den spesifiserte DocString og dokumentasjonen av funksjonen my_func2 med hjelpefunksjonen.

Resultatene som genereres fra de nevnte kodene er som følger. Denne utgangen genereres ved utførelse av den forrige pålagte koden i Spyder:

Eksempel 3: Program for Python en-linje Docstring

One-line docstrings er akkurat det navnet deres antyder: en linje. De er ansatt i åpenbare situasjoner. De siste sitatene ligger på en lignende linje som de første. For en-liners virker dette mer tiltalende.

Her konstruerer vi en funksjon som "legge til" som tar to argumenter: x og y. Deretter erklærer vi en-linjen Docstring i kroppen til "Add" -funksjonsdefinisjonen. Returoppgaven returnerer verdien fra tillegg av de to verdiene. Utskriftsuttalelsen påkalles for å vise doktoren i tilleggsfunksjonen ved å bruke _DOC_ -objektet.

Resultatene fra en-linjen DocString vises på følgende Spyder-konsollskjerm. Denne utgangen genereres ved utførelse av ovennevnte kode i Spyder:

Eksempel 4: Program for en Python Multi-Line Docstring

I likhet med en-linjen Docstrings, starter multi-linjene Docstrings med en sammendragslinje og slutter med en tom linje før de beskriver noe i større detalj. Sammendragslinjen kan vises på en lignende linje som begynnelsestilbud eller på en annen linje. En multiline docstring er demonstrert i følgende forekomst:

I dette spesielle eksemplet har vi funksjonsdefinisjonen som får et navn som Python_Function. Denne funksjonen tar en argumentverdi x. Funksjonsorganet er deklarert med multi-linjestrengen som er beskrivelsen av argumentverdien og Int-datatypen. Etter det er returkommandoen definert. Multiline DocString vises ved å ringe _DOC_ -objektet inne i utskriftsfunksjonen.

Multilinjene av DocString er skrevet ut på Spyder-terminalen som følger:

Eksempel 5: Program for Python DocString -innrykk

Sitatene på den første linjen er innrykket på samme måte som resten av doktoren. Hver innrykk i DocStrings første linje (opp med den første nye linjen) er unødvendig og bør elimineres. Etterpå holder linjene i doktoren sin relative innrykk. Som en illustrasjon om hvordan du lager dokumentene for en klasse og dens metoder, la oss se på et eksempel. Tilgangen til DocString er gjennom hjelp:

Vi definerer en klasse med nøkkelordklassen og navngir den klassen som my_python_example. Inne. Deretter oppretter vi funksjonen Square som har inngangen X, og funksjonen er også erklært med DocString. Deretter oppretter vi en annen funksjon med navnet, Cube. Det tar også en inngang n. Denne funksjonen opprettes for kuben til nummeret. Denne uttalelsen er forklart med DocString -erklæringen. Etter det har vi en Python -hjelpemål for å utføre dokumentasjonen av MY_PYTHON_PROGRAM -klassen og funksjonen Square.

Fra det tidligere nevnte Python -programmet oppnås følgende utdata. Denne utgangen genereres ved utførelse av den tidligere pålagte koden i Spyder:

Konklusjon

Hovedmålet med dette kurset er å gjøre deg kjent med Docstrings ved å gå gjennom grunnleggende ideer. Fordi Docstrings er et så bredt tema, er det imidlertid mulig at noen ideer ble hoppet over. For å få en funksjons dokumentasjon, bruk hjelp () -funksjonen. Legg en streng, enten en enkeltlinjestreng eller en multi-linjestreng, i funksjonens første linje for å legge til dokumentasjonen.