Tässä artikkelissa perehdymme Pythonin monirivisten kommenttien käsitteeseen tarjoamalla kattavan määritelmän sekä havainnollistavia esimerkkejä Python-ohjelmointikielellä aiheesta Kuinka kommentoida useita rivejä Python .
java pgm
Mikä on monirivinen kommentti Pythonissa?
Pythonin moniriviset kommentit viittaavat tekstilohkoon tai lauseisiin, joita käytetään koodissa selittäviin tai dokumentointitarkoituksiin. Toisin kuin yksiriviset kommentit, jotka on merkitty hash-symbolilla (#), moniriviset kommentit on suljettu kolminkertaisilla lainausmerkeillä (``) tai kolminkertaisilla lainausmerkeillä (`'`). Näitä kommentteja käytetään usein antamaan yksityiskohtaisia selityksiä, dokumentaatiota tai huomautuksia koodista, ja ne voivat kattaa useita rivejä. Vaikka Pythonilla ei ole erityistä syntaksia monirivisille kommenteille, kolminkertaisten lainausmerkkien käyttö saavuttaa samanlaisen vaikutuksen, koska tulkki jättää huomioimatta mukana olevan tekstin.
Monirivisten kommenttien tyypit Pythonissa
Python-monirivisiä kommentteja voidaan lisätä koodiimme kahdella tavalla. Ne ovat seuraavat:
- Peräkkäinen yksirivinen kommentti
- Monirivisen merkkijonon käyttäminen kommentina
- Kenoviivamenetelmän käyttäminen
Kommentoi useita rivejä Pythonissa käyttämällä peräkkäistä yksirivistä kommenttia
Sisään Python , hash-merkkiä (#) käytetään kommentoimaan riviä. Yksirivinen kommentteja Pythonissa ei tarvitse olla pelkkä teksti selittämään koodia, vaan niitä voidaan käyttää myös estämään Pythonia suorittamasta koodia. Hash-merkki tulee sijoittaa jokaisen rivin eteen, jotta se katsottaisiin moniriviseksi kommentiksi Pythonissa.
Esimerkki: Peräkkäinen yksirivinen kommentti
Tässä kaksi ensimmäistä riviä sisältävät hash-merkin (#), ja tulkki estää kahta riviä suorittamasta. Sitten se tulostaa Python-kommentit ja lopuksi estää viimeisen rivin suorittamisen.
Python 3
# Write Python3 code here # Single line comment used print('Python Comments') # print('Mathematics')> Lähtö:
Python Comments>
Kommentoi useita rivejä Pythonissa käyttämällä monirivistä merkkijonoa kommentina
Python-moniriviset kommentit voidaan myös sulkea erottimella (). Jälleenkään erottimien () välissä ei saa olla tyhjää tilaa. Ne ovat hyödyllisiä, kun kommenttiteksti ei mahdu yhdelle riville, joten sen on jaettava rivien yli. Tämän tyyppinen merkkijonoliteraali jätetään huomioimatta, koska sitä ei ole määritetty millekään muuttujalle. Voimme käyttää näitä merkkijonoja käyttämällä __doc__.
sql usean taulukon valinta
Esimerkki: Monirivisen merkkijonon käyttäminen kommentina
Monirivisiä kommentteja käytetään kommentoimaan useampaa kuin yhtä riviä. Ensimmäinen rivi on yksirivinen kommentti. Toista ja kolmatta riviä voidaan kommentoida käyttämällä kolmoislainausmerkkejä ( ). Tämä estää yllä olevan koodin suorittamisen. Lopuksi se tulostaa matematiikan tuotteeseen. Jos nämä Python-moniriviset kommentit kuitenkin sijoitetaan suoraan funktion tai luokan allekirjoituksen jälkeen, ne muuttuvat dokumentit .
Python 3
# Write Python code here ''' Multi-line comment used print('Python Comments') ''' print('Mathematics')> Lähtö:
Mathematics>
Kommentoi useita rivejä Pythonissa kenoviivamenetelmällä
Menetelmä monirivisten kommenttien luomiseen Pythonissa sisältää kenoviivan (``) käyttämisen jokaisen rivin lopussa rivinjatkamisominaisuuden käyttämiseksi, jolloin kommentit voivat ulottua seuraavalle riville. Tämä rivinjatkamismenetelmä on vähemmän yleinen kuin muut lähestymistavat, kuten peräkkäiset yksiriviset kommentit tai moniriviset merkkijonot, ja sitä käytetään ensisijaisesti koodin luettavuustarkoituksiin, kun kommentti on tarpeen jakaa useille riveille.
lataa youtube-videoita vlc
Esimerkki : Tässä esimerkissä kommentit alkaen#>laajennetaan useiksi riveiksi kenoviivalla (>) jokaisen rivin lopussa. Kenoviiva osoittaa, että kommentti jatkuu seuraavalla rivillä. Tämä menetelmä voi olla hyödyllinen parantamaan koodin luettavuutta, kun sinulla on pitkiä kommentteja.
# Using backslash for multiline comments # This is a long comment # that spans multiple lines # using the backslash continuation method. # Code continues below print('Hello, World!')> Lähtö:
Hello, World!>
Docstringit Pythonissa
The dokstring on Pythonin sisäänrakennettu ominaisuus, jota käytetään Python-moduuleiden, funktioiden, luokkien ja menetelmien kanssa kirjoitetun dokumentaation yhdistämiseen. Se lisätään suoraan funktioiden, moduulien tai luokkien alle kuvaamaan niiden toimintaa. Pythonissa dokumenttimerkkijono on sitten saatavilla Python __doc__ attribuutti.
Esimerkki: Docstrings Pythonissa
Tässä esimerkissä multiply()-funktion määrittämisen jälkeen ilmoitimme docstring-kommentin käyttämällä kolminkertaisia lainausmerkkejä. Sitten tulostamme dokumenttimerkkijonon attribuutilla __doc__.
Python 3 def multiply(a, b): '''Multiplies the value of a and b''' return a*b # Print the docstring of multiply function print(multiply.__doc__)>
Lähtö:
css alleviivattu teksti
Multiplies the value of a and b>
Ero kommenttien ja Docstringin välillä Pythonissa
Katsotaanpa ero Python-kommenttien ja Docstringin välillä:
Kommentit | Asiakirjat |
|---|---|
| Ne ilmoitetaan käyttämällä # | Ne on ilmoitettu käyttämällä |
| Käytetään lisäämään koodin luettavuutta | Antaa kuvauksen Python-moduuleista, funktioista ja luokista |
| Niihin ei pääse käsiksi | Niitä voi käyttää käyttämällä __doc__ |