Tässä opetusohjelmassa opimme luomaan kommentteja Pythonissa esimerkkien avulla.
Video: Kommentit Pythonissa
Kommentit ovat kuvauksia, jotka auttavat ohjelmoijia ymmärtämään paremmin ohjelman tarkoituksen ja toiminnallisuuden.
Python-tulkki jättää ne täysin huomiotta.
Kommenttien käytön edut
Kommenttien käyttö ohjelmissa tekee koodistamme ymmärrettävämmän. Se tekee ohjelmasta luettavamman, mikä auttaa meitä muistamaan, miksi tietyt koodilohkot kirjoitettiin.
Tämän lisäksi kommentteja voidaan käyttää myös sivuuttamaan joitain koodeja testattaessa muita koodilohkoja. Tämä tarjoaa yksinkertaisen tavan estää joidenkin rivien suorittaminen tai kirjoittaa pseudokoodi ohjelmalle.
Yksiriviset kommentit Pythonissa
Pythonissa käytetään hash-symbolia #yksirivisen kommentin kirjoittamiseen.
Esimerkki 1: Yksirivisten kommenttien kirjoittaminen
# printing a string print('Hello world')
Tuotos
Hei maailma
Tässä kommentti on:
# printing a string
Python-tulkki jättää tämän rivin huomiotta.
Kaikki, mitä #seuraa, jätetään huomiotta. Joten voimme myös kirjoittaa yllä olevan ohjelman yhdelle riville seuraavasti:
print('Hello world') #printing a string
Tämän ohjelman tulos on sama kuin esimerkissä 1 . Tulkki jättää huomiotta kaiken tekstin jälkeen #.
Moniriviset kommentit Pythonissa
Python ei tarjoa erillistä tapaa kirjoittaa monirivisiä kommentteja. On kuitenkin olemassa muita tapoja kiertää asiaa.
Voimme käyttää #kommenttirivien alussa useita rivejä.
Esimerkki 2: Useiden # numeroiden käyttö
# it is a # multiline # comment
Tällöin kutakin riviä käsitellään yhtenä kommenttina ja ne kaikki jätetään huomiotta.
Merkkijonon literaalit monirivisille kommenteille
Vaikka ei ole ainutlaatuista tapaa kirjoittaa monirivisiä kommentteja Pythoniin, tiedämme, että Python-tulkki jättää huomiotta merkkijonolitraalit, joita ei ole määritetty muuttujalle.
Joten voimme jopa kirjoittaa yhden rivin kommentin:
#this is a comment 'this is an unassigned string as a comment '
Tässä voimme nähdä, että ohjelman toinen rivi on merkkijono, mutta sitä ei ole määritetty mihinkään muuttujaan tai funktioon. Joten tulkki jättää merkkijonon huomiotta.
Vastaavalla tavalla voimme käyttää monirivisiä merkkijonoja (kolminkertaiset lainausmerkit) monirivisten kommenttien kirjoittamiseen.
Lainausmerkki voi olla joko 'tai ".
Esimerkki 3: Merkkijono-kirjainten käyttö monirivisten kommenttien kirjoittamiseen
''' I am a multiline comment! ''' print("Hello World")
Täällä monirivistä merkkijonoa ei ole määritetty mihinkään muuttujaan, joten tulkki jättää sen huomiotta. Vaikka se ei ole teknisesti monirivinen kommentti, sitä voidaan käyttää yhtenä.
Python-käskyt
Kokonaisuuden mukaan kolminkertaiset lainaukset, jotka näkyvät heti funktion, menetelmän tai luokan määrittelyn jälkeen, ovat komentosarjoja.
Käskysarjat liittyvät objekteihin, ja niihin pääsee käsiksi __doc__määritteen avulla.
Saat lisätietoja käymällä Python-käskysarjoissa.
Kuinka kirjoittaa parempia kommentteja?
- Käytä kommentteja kuvaamaan toiminnon toimintaa, älä tarkempia tietoja toiminnon toiminnasta.
- Yritä poistaa niin monta tarpeetonta kommenttia kuin mahdollista. Yritä kirjoittaa koodi, joka selittää itsensä, käyttämällä parempaa funktiota / muuttujan nimen valintaa.
- Yritä tehdä kommentit mahdollisimman lyhyiksi ja ytimekkäiksi.
