logo

Daudzrindu komentāri Python

Šajā rakstā mēs iedziļināsimies Python vairāku rindiņu komentāru jēdzienā, sniedzot visaptverošu definīciju kopā ar ilustratīviem piemēriem Python programmēšanas valodā par to, kā komentēt vairākas rindiņas Python .

Kas ir daudzrindu komentārs Python?

Daudzrindu komentāri programmā Python attiecas uz teksta vai paziņojumu bloku, kas kodā tiek izmantots paskaidrojuma vai dokumentācijas nolūkos. Atšķirībā no vienas rindiņas komentāriem, kas apzīmēti ar jaukšanas simbolu (#), vairākrindu komentāri ir ietverti trīskāršās dubultpēdiņās (``) vai trīskāršās vienpēdiņās (`’`). Šie komentāri bieži tiek izmantoti, lai sniegtu detalizētus paskaidrojumus, dokumentāciju vai piezīmes par kodu, un tie var ietvert vairākas rindiņas. Lai gan Python nav noteiktas sintakses vairāku rindiņu komentāriem, trīskāršu pēdiņu izmantošana nodrošina līdzīgu efektu, jo tulks ignorē pievienoto tekstu.



Daudzrindu komentāru veidi Python

Ir divi veidi, kā mēs varam kodā pievienot Python vairākrindu komentārus. Tie ir šādi:

  • Secīgs vienas rindiņas komentārs
  • Vairāku rindu virknes izmantošana komentāram
  • Izmantojot atpakaļvērstās slīpsvītras metodi

Komentējiet vairākas rindiņas Python, izmantojot secīgus vienas rindiņas komentārus

In Python , jaucējraksts (#) tiek izmantots, lai komentētu rindu. Vienrindas komentāri Python nav jābūt tekstam, lai izskaidrotu kodu, tos var izmantot arī, lai neļautu Python izpildīt kodu. Jaucējraksts jāievieto pirms katras rindiņas, lai Python to uzskatītu par vairākrindu komentāriem.

tīkls un tīklu veidi

Piemērs: Secīgs vienas rindiņas komentārs

Šeit pirmajās divās rindās ir jaucējraksts (#), un tulks neļauj abām rindām izpildīt. Pēc tam tas izdrukā Python komentārus un, visbeidzot, novērsīs pēdējās rindas izpildi.



c++ sadalošā virkne
Python3
# Write Python3 code here # Single line comment used print('Python Comments') # print('Mathematics')>

Izvade:

Python Comments>

Komentējiet vairākas rindiņas programmā Python, kā komentāru izmantojot vairāku rindu virkni

Python vairāku rindiņu komentārus var iekļaut arī atdalītājā (). Atkal nedrīkst būt atstarpes starp norobežotājiem (). Tie ir noderīgi, ja komentāra teksts neietilpst vienā rindiņā, tāpēc tam ir jābūt pāri rindiņām. Šāda veida virknes literāls tiek ignorēts, jo tas nav piešķirts nevienam mainīgajam. Mēs varam piekļūt šīm virknēm, izmantojot __doc__.

Piemērs: Daudzrindu virknes izmantošana komentāram

Vairāku rindiņu komentāri tiek izmantoti, lai komentētu vairāk nekā vienu rindiņu. Pirmā rinda ir vienas rindiņas komentārs. Otro un trešo rindiņu var komentēt, izmantojot trīskāršās pēdiņas ( ). Tas novērš iepriekš minētā koda izpildi. Visbeidzot, tas izdrukā matemātiku. Tomēr, ja šie Python daudzrindu komentāri tiek ievietoti tieši aiz funkcijas vai klases paraksta, tie pārvēršas par dokstrings .



Python3
# Write Python code here ''' Multi-line comment used print('Python Comments') ''' print('Mathematics')>

Izvade:

Mathematics>

Komentējiet vairākas rindiņas Python, izmantojot slīpsvītras metodi

Metode vairāku rindiņu komentāru izveidei programmā Python ietver atpakaļvērstās slīpsvītras (``) izmantošanu katras rindiņas beigās, lai izmantotu rindiņas turpināšanas līdzekli, tādējādi ļaujot komentāram paplašināties līdz nākamajai rindai. Šī rindas turpināšanas metode ir retāk sastopama nekā citas pieejas, piemēram, secīgi vienas rindiņas komentāri vai vairāku rindiņu virknes, un to galvenokārt izmanto koda lasāmības nolūkos, ja ir nepieciešams sadalīt komentāru vairākās rindās.

java salīdzināms interfeiss

Piemērs : šajā piemērā komentāri sākas ar#>tiek paplašinātas līdz vairākām rindām, izmantojot atpakaļvērsto slīpsvītru (>) katras rindas beigās. Slīpssvītra norāda, ka komentārs turpinās nākamajā rindā. Šī metode var būt noderīga, lai uzlabotu koda lasāmību, ja jums ir gari komentāri.

Python3
# Using backslash for multiline comments # This is a long comment  # that spans multiple lines  # using the backslash continuation method. # Code continues below print('Hello, World!')>

Izvade:

Hello, World!>

Docstrings programmā Python

The dokstring ir Python iebūvēta funkcija, ko izmanto, lai saistītu dokumentāciju, kas ir uzrakstīta ar Python moduļiem, funkcijām, klasēm un metodēm. Tas tiek pievienots tieši zem funkcijām, moduļiem vai klasēm, lai aprakstītu to darbību. Programmā Python dokumentācijas virkne pēc tam tiek padarīta pieejama, izmantojot Python __doc__ atribūts.

Piemērs: Python dokumentu virknes

Šajā piemērā pēc tam, kad ir definēta funkcija multiply(), mēs deklarējām docstring komentāru, izmantojot trīskāršās pēdiņas. Pēc tam mēs izdrukājam dokumentu virkni, izmantojot atribūtu __doc__.

Python3
def multiply(a, b):  '''Multiplies the value of a and b''' return a*b # Print the docstring of multiply function print(multiply.__doc__)>

Izvade:

Multiplies the value of a and b>

Atšķirība starp komentāriem un dokumentu virknēm Python

Ļaujiet mums redzēt atšķirību starp Python komentāriem un Docstring:

primārās atslēgas saliktā atslēga

komentāri

Docstrings

Tie ir deklarēti, izmantojot #Tie ir deklarēti, izmantojot
Izmanto, lai palielinātu koda lasāmībuSniedz Python moduļu, funkciju un klašu aprakstu
Tiem nevar piekļūtTiem var piekļūt, izmantojot __doc__