Kommentit Pythonissa ovat koodin rivit, jotka tulkki jättää huomiotta ohjelman suorittamisen aikana.
# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''> |
>
>
Kommentit parantavat koodin luettavuutta ja auttavat ohjelmoijia ymmärtämään koodin erittäin huolellisesti. Se auttaa myös yhteistyössä muiden kehittäjien kanssa, koska kommenttien lisääminen helpottaa koodin selittämistä.
Pythonin kommenttityypit
Pythonissa on kolmenlaisia kommentteja:
- Yksirivinen Kommentit
- Moniriviset kommentit
- String Literaalit
- Docstringin kommentit
Kommentit Pythonissa
Esimerkissä se näkyy Python Tulkki jättää kommentit huomioimatta ohjelman suorittamisen aikana.
Python 3
# sample comment> name>=> 'geeksforgeeks'> print>(name)> |
>
>
Lähtö:
geeksforgeeks>
Miksi Pythonissa käytetään kommentteja?
Kommentit ovat olleet olennainen osa ohjelmointikieliä, ja jokaisella kielellä on erilaisia tapoja käyttää kommentteja.
Kuten kaikilla muillakin kielillä, Pythonin kommentit palvelevat seuraavaa tarkoitusta:
- Paranna koodin luettavuutta
- Koodin selittäminen muille
- Koodin ymmärtäminen, jos sitä opitaan jonkin ajan kuluttua
- Toiminnon vaiheiden ja tarpeiden dokumentointi
- Koodin jakaminen muiden kehittäjien kanssa
- Yhteistyötä useiden ihmisten kanssa.
Pythonin kommenttityypit
Tutustutaanpa erityyppisiin kommentteihin, miten niitä käytetään ja milloin niitä tulee käyttää?
1. Yksirivinen Kommentit
- Pythonin yksirivinen kommentti alkaa hashtag-symbolilla (#) ilman välilyöntejä ja kestää rivin loppuun.
- Jos kommentti ylittää yhden rivin, laita hashtag seuraavalle riville ja jatka Python-kommenttia.
- Pythonin yksiriviset kommentit ovat osoittautuneet hyödyllisiksi lyhyiden selitysten toimittamisessa muuttujille, funktiomäärittelyille ja lausekkeille. Katso seuraava koodinpätkä, joka esittää yhden rivin kommentin:
Esimerkki:
Python 3
java tuples
# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)> |
>
>Lähtö
techcodeview.com>
2. Moniriviset kommentit
Python ei tarjoa vaihtoehtoa monirivisiä kommentteja . On kuitenkin olemassa erilaisia tapoja, joilla voimme kirjoittaa monirivisiä kommentteja.
a) Moniriviset kommentit useilla hashtageilla (#)
Voimme kirjoittaa useita hashtageja (#) monirivisten kommenttien kirjoittamiseen Pythonissa. Jokainen rivi katsotaan yksiriviseksi kommentiksi.
Python 3
# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)> |
>
c# mallikoodi
>Lähtö
Multiline comments>
Tarkista myös: Mielenkiintoinen fakta Python-monirivisistä kommenteista
3. Jousiliteraalit
Python jättää huomioimatta merkkijono literaalit joita ei ole määritetty muuttujaan, jotta voimme käyttää näitä merkkijonoliteraaaleja Python-kommentteina .
a) Yksiriviset kommentit merkkijonoliteraaaleja käyttäen
Suorittaessamme yllä olevaa koodia voimme nähdä, että tulostetta ei tule, joten käytämme merkkijonoja kolminkertaiset lainaukset () monirivisiksi kommenteiksi.
Python 3
'This will be ignored by Python'> |
python-listan alustus
>
>
b) Moniriviset kommentit merkkijonoliteraaleilla
Python 3
''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)> |
>
>Lähtö
Multiline comments>
4. Dokumenttimerkkijono
- Python-dokumenttijono on merkkijonoliteraali kolminkertaisilla lainausmerkeillä, jotka näkyvät heti funktion jälkeen.
- Sitä käytetään Python-moduulien, funktioiden, luokkien ja menetelmien kanssa kirjoitetun dokumentaation yhdistämiseen.
- Se lisätään suoraan funktioiden, moduulien tai luokkien alle kuvaamaan niiden toimintaa. Pythonissa asiakirjamerkkijono on sitten saatavilla __doc__-attribuutin kautta.
Esimerkki:
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ö:
Multiplies the value of a and b>
Kommenttien edut Pythonissa
Kommentteja käytetään yleensä seuraaviin tarkoituksiin:
- Koodin luettavuus
- Projektin koodin tai metatietojen selitys
- Estä koodin suorittaminen
- Resurssien sisällyttäminen
Oikea tapa kirjoittaa kommentteja
Kommentit ovat pääasiallinen tarkoitus koodisi selittämisessä. Kehittäjät käyttävät terveellistä kommenttien kirjoituskäytäntöä ymmärtääkseen koodia paremmin.
Jotkut vinkit, joita voit noudattaa tehdäksesi kommenteistasi tehokkaita, ovat:
- Kommenttien tulee olla lyhyitä ja tarkkoja.
- Käytä kommentteja vain tarvittaessa, älä sotke koodiasi kommenteilla.
- Kommentilla pitäisi olla jokin merkitys.
- Vältä yleisten tai peruskommenttien kirjoittamista.
- Kirjoita kommentteja, jotka selittävät itsestään.
Olemme keskustelleet kaikesta Python-kommenteista, Python-kommenttien kirjoittamisesta, kommenttityypeistä, mitkä ovat sen edut ja oikea tapa kirjoittaa kommentteja.
Lue myös: Kuinka kirjoittaa kommentteja Python3:ssa?