Tā kā mēs jau zinām, kā rakstīt vairākrindu komentārus, mēs varam izmantot trīskāršās vai trīskāršās dubultpēdas. Mēs izmantojam dokumentācijas virkni, ja vēlamies aprakstīt savas funkcijas, lai mēs varētu iegūt dokumentāciju, kad tā ir nepieciešama. Daži IDE sniedz jums dokumentāciju, vienkārši virzot kursoru virs nosaukuma, un daži izceļ noteiktus atslēgvārdus. Bet fakts ir tāds, ka NumPy dokumentu virknes ir daudz elastīgākas nekā citās valodās. Docstring ir virknes burts, kas parādās funkcijas definīcijas sākumā. Mums ir jānodrošina konkrētas vērtības, vienlaikus izmantojot docstring funkcijas, klases utt.
Izmantojot docstring ar funkcijām, mums ir jānodod argumenti. Izmantojot tos ar klasēm, mēs nododam atribūtus un metodes. Moduļu gadījumā mums ir jānodrošina klašu un funkciju saraksts. Pakotnes gadījumā mēs nododam moduļu sarakstu ar funkcionalitāti. Tātad būtībā dokumenta virknes mērķis, kā paskaidro nosaukums, ir tas, ka tā palīdz mūsu koda dokumentācijā. Mēs veicam dokumentāciju, lai, ja kāds turpmāk izmantos mūsu kodu, viņš ar docstring palīdzību varētu saprast mūsu kodu un koda loģiku. Iebūvētajās funkcijās ir arī docstrings; mēs varam izmantot funkciju help(), lai apskatītu iebūvēto funkciju docstring.
Pastāv dažas atšķirības starp komentāriem un dokumentu virknēm. Tulki ignorē komentārus, bet tulki neņem vērā dokumentu virknes. Atmiņa ir atvēlēta dokumentu virknēm. Komentārs ir koda apraksts, bet, no otras puses, dokumentu virknes norāda koda mērķi.
Sintakse:
Sintakse dokumentu virkņu rakstīšanai programmā NumPy ir šāda:
'''Dokumentu virknes ziņojums'''
Or
'''Dokumentu virknes ziņojums'''
Lūdzu, ņemiet vērā, ka dokumentu virkne nav funkcija vai metode, tāpēc tai nav pareizas sintakses. Vienīgais, kas šeit jāņem vērā, ir tas, ka mēs sākam dokumentu virkni ar trim vienpēdiņām vai trim dubultpēdiņām. Mēs uzrakstām koda aprakstu un beidzam to vēlreiz ar trim vienpēdiņām vai trīs dubultpēdiņām beigās. Dokumentu virknēm nav obligāti jāraksta. Jums vienkārši jāievieto trīs vienpēdiņas vai dubultpēdiņas pirms un pēc virknes apraksta.
1. piemērs:
Lai labāk izprastu dokumentu virknes, sniegsim piemēru. Šajā piemērā pēc NumPy bibliotēkas iekļaušanas mēs vienkārši deklarējam mainīgo “a” un citu mainīgo “b”. Pēc tam mēs izveidojam savu dokumentu virkni, kas saka: “Pievienosim “a” un “b” mainīgos”. Mūsu gadījumā šis ir vienkāršs piemērs, taču, ja mūsu kods ir sarežģīts, tas kodētājam ļoti palīdz saprast kodu. Pēc tam mēs summējam mainīgos “a” un “b” un saglabājam to izvades rezultātu citā mainīgajā, kas ir “c”. Visbeidzot, mēs izdrukājam mainīgā “c” vērtību. Tagad mēs izpildām savu kodu.
imports nejutīgs kā piem.a = 1
b = divi
''''Pievienosim a un b mainīgos'''
c = a+b
drukāt ( c )
Šī ir mūsu dotā koda daļa. Mēs redzam, ka sistēma mūsu koda 7. rindiņai nav devusi kļūdu par nepareizu sintakse vai neko citu. Turklāt sistēma nav izdrukājusi mūsu dokumentu virkni. Tā vietā tas izdrukāja tikai mūsu mainīgā “c” izvadi, kurā mēs likām sistēmai drukāt. Tas parāda, kā darbojas dokumentu virknes. Nākamreiz, kad jauns kodētājs mēģinās strādāt pie mūsu koda, viņš sapratīs, ko mēs darām, izmantojot mūsu dokumentu virkni. Bet tas netiks izdrukāts kā izvade, lai koda lietotājs tas netraucētu.
2. piemērs:
Tagad mēs veicam sarežģītu piemēru, lai izprastu dokumentācijas virknes darbību. Pirmkārt, mēs iekļaujam NumPy bibliotēku un pēc tam ierakstām doc virkni, kurā izskaidrojam nākamo koda rindiņu, kurā izskaidrojam masīva inicializēšanu. Mēs arī pievienojam dokumentācijas virknes citā koda daļā. Tagad, ja mēs kopīgosim šo kodu ar jebkuru jaunu Python izstrādātāju, nepievienojot dokumentu virknes, viņam būs grūti uzzināt šī koda darbību un mērķi. Viņam vispirms ir jāmeklē mūsu izmantotās funkcijas. Bet, ja mēs savam kodam pievienosim dokumentu virkni, pārējie izstrādātāji varēs viegli saprast kodu, nepētot vairāk par funkcijām. Mēs neaprobežojamies ar komentāru pievienošanu dažiem ierobežojumiem; komentāri var būt no vienas vai vairākām rindiņām. Kodā to var pievienot arī vairāk nekā vienu reizi. Pēc tam importējiet NumPy kā np.
''''Mainīgā izveidošana, kuram nodosim masīvu ar izmēru 1x6'''masīvs = piem. masīvs ( [ vienpadsmit , 22 , 33 , 44 , 55 , 66 ] )
''''masīva piešķiršana funkcijai tofile(), lai ļautu to saglabāt failā arr'''
masīvs . uz failu ( 'arr.bin' )
''''parādīt failu, izmantojot funkciju fromfile'''
drukāt ( piem. no faila ( 'arr.bin' , dtype = starpt ) )
Kā parādīts nākamajā fragmentā, dokumentu virknes netiek parādītas izvadē, kas nozīmē, ka tas neietekmē koda izvadi vai kompilāciju. Dokumentu virknes tiek ignorētas kompilācijas procesā.
Secinājums
Šajā rokasgrāmatā mēs uzzinājām par NumPy dokumentu virknēm. Mēs salīdzinājām dokumentu virknes ar komentāriem un izskaidrojām atšķirību starp tām. Mēs uzzinājām dokumentu virkņu sintaksi un to, kā rakstīt dokumentācijas virknes savā kodā. Turklāt mēs arī mēģinājām izskaidrot, kas ir NumPy dokumentācijas un kā tās darbojas, izmantojot piemērus. Visbeidzot, mēs atzīmējām, ka tie ir būtiski kodētājiem. Mēs neatkārtosim dokumentu virkņu nozīmi programmā NumPy. Mēs vienkārši teiksim, ka kodā ir jāizmanto dokumentu virknes. Programmā NumPy vispopulārākais ir dokumentu virkņu rakstīšanas stils. Programmēšanas kopienā to plaši izmanto, lai informētu viens otru par savu kodu darbību un funkcionalitāti. Šī rokasgrāmata palīdzēs jums sākt darbu ar NumPy docstrings. Mēs centāmies aptvert lielāko daļu no tā, kas jums būs nepieciešams, izmantojot NumPy dokumentu virknes.