Python-komentosarja

Asiakirjat ovat välttämättömiä, jotta ohjelmointi ymmärtää koodin helposti. Sitä käytetään selittämään minkä tahansa lauseen, funktion, luokan tai moduulin käyttötarkoitus ohjelmassa. Se auttaa pääkooderia muistamaan minkä tahansa koodin toiminnan pitkään, ja se auttaa myös muita koodereita, jotka haluavat työskennellä saman projektin parissa. Kooderi käyttää yhtä kommenttiriviä selittämään koodin toiminnon tietyn osan nopeasti. Python-asiakirjamerkkijonoa tai komentosarjaa käytetään selittämään koodin tietyn segmentin toiminta yksityiskohtaisesti. Ohjausviivan tulisi alkaa isolla kirjaimella ja päättyä pisteeseen. Asiakirjojen ensimmäinen rivi sisältää lyhyen kuvauksen asiakirjoista yleensä. Dokstringin toisen rivin tulisi olla tyhjä suurelle moniriviselle komentoriville. Kolme lainausmerkkiä ('') tai kolminkertaiset lainausmerkit (“” ”) käytetään määrittelemään docstring Pythonissa. Asiakirjan sisältöä voi käyttää käyttämällä __doc__ objektin attribuutti ja käyttämällä auta() menetelmä. Tapa deklaroida ja käyttää docstringia Pythonissa on esitetty tässä opetusohjelmassa.

Esimerkki 1: Funktion komentosarjaan pääsy __doc__ määritteen

Tapa mukautetun funktion komentosarjan ilmoittamiseen ja käyttämiseen on esitetty seuraavassa komentosarjassa. Seuraava komentosarja laskee x: nⁿ missä x ja n otetaan käyttäjältä. Teho () function on määritelty komentosarjassa tehtävän suorittamiseksi. Tässä komento on määritetty tälle toiminnolle. __doc__ attribuuttia on käytetty komentosarjassa tulostamaan docstring lähdön kanssa.

def-teho (x, n):
"Laske x tehoksi n
Lue x: n ja n: n arvot funktion argumenteista
ja Laske ja palauta x: n arvo tehoon n."
paluu x ** n
# Ota x: n arvo
x = int (input ('Syötä x: n arvo:'))
# Ota n: n arvo
n = int (input ('Syötä n: n arvo:'))
# Tulosta funktion paluuarvo
tulosta ("% d tehoon% d =% d"% (x, n, teho (x, n)))
# Tulosta käskyn arvo
print ("Asiakirjan merkkijonon sisältö: \ n" + teho.__doc__)

Tuotos:

Seuraava lähtö tulee näkyviin yllä olevan komentosarjan suorittamisen jälkeen.

Esimerkki 2: Luokan ja menetelmän komentoriville pääsy auta() menetelmä

Tapa julistaa ja käyttää asiakirjan komentosarjaa ja kyseisen luokan menetelmät on osoitettu seuraavassa komentosarjassa. Skriptin päätoiminto on lajitella numeerinen luettelo ja kääntää luettelon tiedot. Luokassa on ilmoitettu numeerinen luettelo 8 elementistä, ja komentosarja on määritelty luokan alussa käyttämällä kolminkertaisia ​​lainausmerkkejä. Lajittelulista () -menetelmä on määritelty luokassa tulostamaan luettelon lajitellut tiedot, ja asiakirja on määritellyt tämän tätä menetelmää varten. käänteinen_lista () menetelmä on määritetty tulostamaan luettelon päinvastaiset tiedot, ja tälle menetelmälle on määritetty myös komentosarja. auta() method on kutsunut kolme kertaa komentosarjan lopussa tulostamaan .dstrstr list_operations luokassa, lajittelulista () menetelmä ja käänteinen_lista () menetelmä.

luokan luettelo_operaatiot:

luokan luettelo_operaatiot:
"
Luettelotietojen lajittelu ja kääntäminen
Luokka sisältää kaksi menetelmää,
sort_list () -menetelmä lajittelee ja tulostaa luettelon,
sort_reverse () -menetelmä kääntää ja tulostaa luettelon.
"
# Määritä luettelo numeerisista tiedoista
luettelotiedot = [23, 67, 23, 6, 45, 3, 90, 11]
def lajittelulista (itse):
"
Tulosta luetteloarvot lajittelun jälkeen
Funktio ottaa argumentista numeeristen tietojen luettelo-objektin,
lajittele luetteloarvot lajittelu () -menetelmällä
ja tulosta lajitellun luettelon arvot.
"
# Lajittele luettelo
itse.luettelotiedot.järjestellä()
# Tulosta lajiteltu luettelo silmukalla
tulosta ("Lajiteltujen luetteloiden arvot: \ n")
arvon itsessä.listdata:
tulosta (arvo, "", loppu = ")
def käänteinen_lista (itse):
"
Tulosta luettelon arvot peruutuksen jälkeen
Funktio ottaa argumentista numeeristen tietojen luettelo-objektin,
kääntää luetteloarvot käänteisellä () -menetelmällä
ja tulosta käännetyn luettelon arvot.
"
# Käänteinen luettelo
itse.luettelotiedot.käänteinen()
# Tulosta käännetty luettelo silmukalla
tulosta ("Lajiteltujen luetteloiden arvot: \ n")
arvon itsessä.listdata:
tulosta (arvo, "", loppu = ")
# Tulosta luokan docstring-arvo
ohje (luettelo_operaatiot)
# Luo luokan objekti
obj = lista_operaatiot ()
# Tulosta tietyn menetelmän käskyn arvo
apua (obj.lajittelulista)
# Kutsu menetelmä tulostaaksesi lajiteltu luettelo
obj.lajittelulista ()

Tuotos:

Seuraava tulos tulee näkyviin komentosarjan suorittamisen jälkeen. Kaikki komentosarjan komentosarjat on tulostettu ensimmäistä kertaa auta() toiminto. Docstring n lajittelulista () menetelmä on painettu toiselle auta() toiminto.

Esimerkki 3: Sisäisen Python-moduulin komentosarjan käyttö

Aikaisemmissa esimerkeissä docstringia on käytetty käyttäjän määrittelemässä luokassa ja toiminnossa. Jokaisella sisäänrakennetulla Python-moduulilla ja luokassa on docstring, joka selittää kyseisen moduulin tai toiminnon käyttötarkoituksen. Moduulin tai toiminnon kooderi määrittelee käskyn, jotta koodi olisi ymmärrettävä käyttäjille. Seuraava komentosarja tulostaa päivämäärämoduulin ennalta määritetyn käskyn käyttämällä auta() toiminto.

# Tuo päivämäärä-moduuli
Tuo päivämäärä
# Näytä päivämäärän komento
ohje (päivämäärä)

Tuotos:

Seuraava lähtö tulee näkyviin komentosarjan suorittamisen jälkeen. Päivämäärä-moduulin käsky näyttää sen yksityiskohtaisen dokumentaation, joka auttaa muita tuntemaan tässä moduulissa määriteltyjen luokkien ja menetelmien toiminnot oikein.

Päätelmä:

Oikea dokumentaatio on välttämätöntä, kun jokin moduuli tai toiminto toteutetaan tiettyä tarkoitusta varten, jotta toinen kooderi voi käyttää moduulia koodissaan tietyn tehtävän suorittamiseen. Jos dokumentaatiota ei ole määritelty moduulille tai toiminnolle oikein, muilla käyttäjillä on ongelmia sen käytössä. Joten jokaisen kooderin on käytettävä asiakirjan komentosarjaa tarjotakseen yksityiskohtaisia ​​tietoja muille koodin ymmärtämiseksi.