Kommentit Pythonissa Kommenttien luominen Pythonissa

Sisällysluettelo:

Anonim

Johdatus kommentteihin Pythonissa

On tärkeää ymmärtää ohjelmoinnin kulku, mitä koodataan ja mihin. Yleensä tämän tekemiseksi ohjelmoija käyttää kommentteja osoittaakseen, mikä on kyseinen koodinumero, mitä menetelmää käytetään koodaukseen / logiikka sen takana. Nämä kommentit eivät aio vaikuttaa koodiin, mutta ne tarjoavat asettelun mitä tehdään. Kommenttien kirjoittaminen koodina auttaa parantamaan koodia, koska optimoinnissa ohjelmoija tarkistaa, mitä on parannettava, ja jos kommentit osoittavat käytetyn menetelmän, ohjelman on helppo optimoida. Pythonin kommentit antavat myös muille kehittäjille tietää ja ymmärtää ohjelman. On suositeltavaa käyttää riittävä määrä kommentteja, jotta koodi ei olisi sekava, kun se katsottiin taaksepäin.

Syntaksityypit Pythonissa

Pythonissa kommentteihin käytetään kahta tyyppiä syntaksia:

#: Is used to comment on one line.

Triple quotes (“): To comment more than one line.

Kaikissa ohjelmointikielissä on määritelty jokin syntaksi, mikä tunnistaa mitä. Ohjelma määritetään useilla syntaksilla, esimerkiksi rivin sulkemiseksi c: ssä käyttämällä puolipistettä ';', luokan tai silmukan alkamisen määrittelemiseksi käytetään kaksoispistettä ':'. Kuten voidaan nähdä, meillä on erilainen syntaksi, joka on osa koodia ja vaikuttaa siihen. Sinun tulisi olla syntaksi, joka voisi sanoa suosittelija jättää kommentoidun osan ja siirtyä seuraavaan vaiheeseen, koska kommentteilla ei ole mitään tekemistä tulosteen kanssa. Joten, on todella tarpeen erottaa kommentit todellisesta koodista, jotta sitä ei pidä sekoittaa todelliseen ohjelmaan.

Kommenttien luominen Pythonissa

Ohjelmoijan on lisättävä kommentti ohjelmaansa ymmärtääksesi sitä paremmin. Mihin lisätä kommentteja? Se on yksilön valinta, mutta tässä on joitain yleisiä paikkoja, joissa kommenttien lisääminen tekee ohjelmasta luettavan.

  1. Ohjelman alku
  2. Kun määritetään parametreja
  3. Luokan määritteleminen
  4. Menetelmien määrittely
  5. Menetelmien / toimintojen logiikka
  6. Kuvaus Tietoja toimenpiteestä
  7. Koodiosan ulostulon ristiintarkistus

Seuraavat seikat on selitetty alla:

1. Ohjelman alku

Tässä ohjelmoija määrittelee mikä on ongelmalause ja mikä on ohjelman tarve.

2. Määritettäessä parametreja

Täällä ohjelmoija voi lisätä kommentteja jokaiselle parametrille, mitä se tarkoittaa, kuinka se auttaa ohjelmassa.

3. Luokan määritteleminen

Ohjelma voi sisältää nolla / yhden tai useamman luokan, joten on välttämätöntä määritellä luokan tarkoitus kommenttien alussa. Joskus on suositeltavaa lisätä kommentteja luokan väliin luokan jokaisen rivin työn määrittelemiseksi.

4. Menetelmien määrittely

Menetelmät ovat toimintoja, jotka luovat suhteita parametrien ja logiikan välillä sen käsittelemiseksi. On suositeltavaa määritellä menetelmän työ kommenteissa.

5. Menetelmien / toimintojen logiikka

Yleensä menetelmään voi olla liitetty useita logiikoita, kunkin logiikan kommentointikuvaus voi auttaa ymmärtämään olemassa olevaa logiikkaa, ja sitä voidaan tarvittaessa muokata vaatimuksen mukaisesti.

6. Menettelyn kuvaus

Ohjelmoija noudattaa kutakin ohjelmaa kohden vaiheittain ja menettelyn vaiheiden / koodin arkkitehtuurin määritteleminen kommenteissa voisi auttaa parantamaan sen luettavuutta.

7. Koodiosan tulosteen ristiintarkistus

Monissa tapauksissa ohjelmoijan on tehtävä muutoksia nykyiseen ohjelmaan. Jos ohjelmalla on useita logiikoita ja jotta voidaan tarkistaa, toimivatko kaikki hyvin, ohjelmalla tulisi olla referenssilähtö / odotettu lähtö. Kommentit logiikan tuotoksista heti logiikan jälkeen voisi säästää paljon aikaa.

Esimerkkejä Pythonin kommentista

Esimerkit on annettu alla:

Kommenteilla ei ole mitään vaikutusta tulokseen, niin ikinä, mutta ne tekevät ohjelmasta luettavamman. Tässä on esimerkkejä pythonin kommentista.

1. Kommentoi yhtä riviä kerrallaan: Tässä suoritamme lisätoiminnon kahdelle muuttujalle.

# Performing addition of two variables
a = 12 # defining variable a and its value
b = 10 # defining variable b and its value
addition = a + b # Addition logic definition
print(addition) # getting output

Lähtö: 22

2. Usean rivin kommentointi kerrallaan: Joskus vaaditaan kuvaus jostakin logiikasta, jota varten on tarpeen kommentoida useita rivejä kerrallaan. Yhden rivin kommentointi uudestaan ​​ja uudestaan ​​voi olla väsyttävää työtä, joten käytämme tähän kolminkertaisia ​​lainauksia.

"""
These lines are commented to perform addition task
We will define two variables
we will apply addition logic
we will print the output
"""
a = 12
b = 10
addition = a + b
print(addition)

Lähtö: 22

3. Kommentoi yhtä riviä ja useita rivejä samanaikaisesti: Ohjelmoija käyttää useimmissa tapauksissa kumpaakin tyyppisiä kommentteja ohjelman luettavuuden parantamiseksi.

"""
These lines are commented to perform addition task
We will define two variables
we will apply addition logic
we will print the output
“””
a = 12 # defining variable a and its value
b = 10 # defining variable b and its value
addition = a + b # Addition logic definition
print(addition) # getting output

Lähtö: 22

Täällä olemme nähneet joitain tapauksia kommentteja, joita käytetään ohjelmassa. Koneoppimisessa on erityyppisiä malleja, joita käytetään ennustamaan tulos. Algoritmissa käytettyjen parametrien, hyperparametrien ja proseduurin mallintaminen on tarpeen. Kommentoimalla malleja erilaisilla lähestymistavoilla, joilla on eri parametrit, voidaan säästää toistettavuutta ja säästää aikaa.

Johtopäätös - Kommentit Pythonissa

Ohjelman kommentit ovat erittäin hyödyllisiä niiden ymmärtämisessä. Pythonissa meillä on periaatteessa kahden tyyppisiä kommentteja joko kommentoidaksesi yhtä riviä (#) -syntaksin kanssa tai kommentoidaksesi useita rivejä, käytämme kolminkertaisia ​​lainausmerkkejä (“). Kommentit eivät ole siinä, että ne vaikuttavat koodiin, vaan vain lisätäksesi kuvaus siitä, mitä siellä koodataan. Kommentit eivät kuulu tulokseen.

Suositellut artikkelit

Tämä on opas kommentteihin Pythonissa. Tässä keskustellaan johdannosta, kommenttien luomisesta Pythonissa on otettu huomioon, esimerkkeistä ja syntaksista jne. Voit myös käydä läpi muiden ehdotettujen artikkeleidemme saadaksesi lisätietoja -

  1. Vaihtaminen Pythonissa
  2. Python-komennot
  3. Käänteinen suunnittelu Pythonilla
  4. Vaihto C: ssä
  5. Muuttujat JavaScript
  6. Käänteinen suunnittelu | Käyttää | Eettiset ongelmat
  7. Kuinka kommentit toimivat PHP: ssä? | esimerkit