Šajā apmācībā mēs iemācīsimies izveidot komentārus Python ar piemēru palīdzību.
Video: komentāri Python
Komentāri ir apraksti, kas programmētājiem palīdz labāk izprast programmas nolūku un funkcionalitāti.
Python tulks tos pilnībā ignorē.
Komentāru izmantošanas priekšrocības
Komentāru izmantošana programmās padara mūsu kodu saprotamāku. Tas padara programmu vieglāk lasāmu, kas mums palīdz atcerēties, kāpēc tika uzrakstīti noteikti koda bloki.
Izņemot to, komentārus var izmantot arī, lai ignorētu dažus kodus, testējot citus koda blokus. Tas piedāvā vienkāršu veidu, kā novērst dažu rindu izpildi, vai uzrakstīt ātru programmas pseidokodu.
Vienrindas komentāri Python
Programmā Python mēs izmantojam jaukšanas simbolu, #lai uzrakstītu vienas rindas komentāru.
1. piemērs: Vienrindas komentāru rakstīšana
# printing a string print('Hello world')
Rezultāts
Sveika pasaule
Šeit komentārs ir:
# printing a string
Šo rindu Python tulks ignorē.
Viss, kas seko pēc tam, #tiek ignorēts. Tātad, mēs varam arī uzrakstīt iepriekš minēto programmu vienā rindā kā:
print('Hello world') #printing a string
Šīs programmas produkcija būs tāda pati kā 1. piemērā . Tulks ignorē visu tekstu pēc #.
Daudzrindu komentāri Python
Python nepiedāvā atsevišķu veidu, kā rakstīt daudzrindu komentārus. Tomēr ir arī citi veidi, kā apiet šo jautājumu.
#Katras komentāra rindas sākumā mēs varam izmantot vairākas rindiņas.
2. piemērs: vairāku # izmantošana
# it is a # multiline # comment
Šeit katra rinda tiek uzskatīta par vienu komentāru, un visi no tiem tiek ignorēti.
Stīgu literāti daudzrindu komentāriem
Pat ja nav unikāla veida daudzrindu komentāru rakstīšanai Python, mēs zinām, ka Python tulks ignorē virknes literālus, kas nav piešķirti mainīgajam.
Tātad, mēs pat varam uzrakstīt vienas rindas komentāru kā:
#this is a comment 'this is an unassigned string as a comment '
Šeit mēs varam redzēt, ka programmas otrā rinda ir virkne, bet tā nav piešķirta nevienam mainīgajam vai funkcijai. Tātad tulks ignorē virkni.
Līdzīgā veidā mēs varam izmantot daudzrindu virknes (trīskāršās pēdiņas), lai rakstītu daudzrindu komentārus.
Citāta raksturs var būt 'vai ".
3. piemērs: String Literals izmantošana vairākrindu komentāru rakstīšanai
''' I am a multiline comment! ''' print("Hello World")
Šeit daudzrindu virkne nav piešķirta nevienam mainīgajam, tāpēc tulks to ignorē. Lai arī tehniski tas nav daudzrindu komentārs, to var izmantot kā vienu.
Python instrukcijas
Pēc vienošanās trīskāršās pēdiņas, kas parādās uzreiz pēc funkcijas, metodes vai klases definīcijas, ir docstrings (dokumentācijas virknes).
Instrukcijas ir saistītas ar objektiem, un tām var piekļūt, izmantojot __doc__atribūtu.
Lai uzzinātu vairāk, apmeklējiet Python docstrings.
Kā rakstīt labākus komentārus?
- Izmantojiet komentārus, lai aprakstītu funkcijas darbību, nevis konkrētu informāciju par to, kā funkcija to dara.
- Mēģiniet noņemt pēc iespējas vairāk lieku komentāru. Mēģiniet uzrakstīt kodu, kas var izskaidrot pats sevi, izmantojot labāku funkciju / mainīgā nosaukuma izvēli.
- Centieties izteikt komentārus pēc iespējas īsākus un īsākus.
