Šioje pamokoje išmoksime kurti komentarus „Python“ pavyzdžių pagalba.
Vaizdo įrašas: „Python“ komentarai
Komentarai yra aprašymai, kurie padeda programuotojams geriau suprasti programos tikslą ir funkcionalumą.
Jas „Python“ vertėjas visiškai ignoruoja.
Komentarų naudojimo pranašumai
Naudojant komentarus programose, mūsų kodas tampa suprantamesnis. Tai daro programą lengviau skaitomą, o tai padeda mums prisiminti, kodėl buvo parašyti tam tikri kodo blokai.
Be to, komentarai taip pat gali būti naudojami ignoruojant tam tikrą kodą bandant kitus kodo blokus. Tai suteikia paprastą būdą užkirsti kelią kai kurių eilučių vykdymui arba parašyti greitą programos pseudokodą.
Vienos eilutės komentarai „Python“
„Python“ naudojame maišos simbolį #vienos eilutės komentarui parašyti.
1 pavyzdys: vienos eilutės komentarų rašymas
# printing a string print('Hello world')
Rezultatas
Labas pasauli
Čia komentaras:
# printing a string
Šią eilutę nepaiso „Python“ vertėjas.
Viskas, kas ateina, #yra ignoruojama. Taigi, aukščiau nurodytą programą taip pat galime parašyti vienoje eilutėje:
print('Hello world') #printing a string
Šios programos išvestis bus tokia pati kaip 1 pavyzdyje . Vertėjas ignoruoja visą tekstą po #.
Kelių eilučių komentarai „Python“
„Python“ nesiūlo atskiro kelių komentarų rašymo būdo. Tačiau yra ir kitų būdų apeiti šią problemą.
#Kiekvienos komentaro eilutės pradžioje galime naudoti kelias eilutes.
2 pavyzdys: kelių # naudojimas
# it is a # multiline # comment
Čia kiekviena eilutė traktuojama kaip vienas komentaras ir visi jie nepaisomi.
Styginiai daugelio eilučių komentarai
Nors nėra unikalaus būdo parašyti daugelio eilutės komentarus „Python“, mes žinome, kad „Python“ vertėjas ignoruoja eilutės literalus, kurie nėra priskirti kintamajam.
Taigi, mes netgi galime parašyti vienos eilutės komentarą:
#this is a comment 'this is an unassigned string as a comment '
Čia galime pamatyti, kad antroji programos eilutė yra eilutė, tačiau nėra priskirta jokiam kintamajam ar funkcijai. Taigi, vertėjas nepaiso eilutės.
Panašiai galime naudoti kelių eilučių eilutes (trigubas kabutes), norėdami parašyti kelių eilučių komentarus.
Citatos simbolis gali būti 'arba ".
3 pavyzdys: Styginių literatų naudojimas rašant kelių eilučių komentarus
''' I am a multiline comment! ''' print("Hello World")
Čia kelių linijų eilutė nėra priskirta jokiam kintamajam, todėl vertėjas jos nepaiso. Nors techniškai tai nėra kelių eilučių komentaras, jį galima naudoti kaip vieną.
„Python“ instrukcijos
Pagal susitarimą trigubos kabutės, atsirandančios iškart po funkcijos, metodo ar klasės apibrėžimo, yra instrukcijos (dokumentacijos eilutės).
Instrukcijos yra susietos su objektais ir jas galima pasiekti naudojant __doc__atributą.
Norėdami sužinoti daugiau, apsilankykite „Python“ instrukcijose.
Kaip parašyti geresnius komentarus?
- Naudokite komentarus, kad apibūdintumėte, ką funkcija veikia, o ne konkrečią informaciją apie tai, kaip ji veikia.
- Pabandykite pašalinti kuo daugiau nereikalingų komentarų. Pabandykite parašyti kodą, kuris gali paaiškinti save, naudodamas geresnę funkciją / kintamojo pavadinimo pasirinkimą.
- Pabandykite komentarus pateikti kuo trumpesnius ir trumpesnius.
