Dahil alam na namin kung paano isulat ang mga multiline na komento, maaari naming gamitin ang triple single quotes o triple double quotes. Gumagamit kami ng string ng dokumentasyon kapag gusto naming ilarawan ang aming mga function upang makuha namin ang dokumentasyon kapag kailangan namin ito. Ang ilang IDE ay nagbibigay sa iyo ng dokumentasyon sa pamamagitan lamang ng pag-hover sa pangalan at ang ilan ay nagha-highlight ng ilang partikular na keyword. Ngunit ang katotohanan ay ang mga docstring sa NumPy ay mas nababaluktot kaysa sa ibang mga wika. Ang Docstring ay isang literal na string na nangyayari sa simula ng kahulugan ng function. Kailangan nating magbigay ng mga partikular na halaga habang ginagamit ang mga docstring sa mga kaso ng mga function, klase, atbp.
Kapag gumagamit ng mga docstring na may mga function, kailangan nating ipasa ang mga argumento. Kapag ginagamit ang mga ito sa mga klase, ipinapasa namin ang mga katangian at pamamaraan. Sa kaso ng Modules, kailangan naming magbigay ng listahan ng mga klase at function. Sa kaso ng package, ipinapasa namin ang listahan ng mga module na may functionality. Kaya karaniwang, ang layunin ng docstring ay, gaya ng ipinaliwanag ng pangalan, na nakakatulong ito sa dokumentasyon ng aming code. Gumagawa kami ng dokumentasyon upang kung may gumamit ng aming code sa hinaharap, mauunawaan niya ang aming code at ang lohika sa likod ng aming code sa tulong ng docstring. Ang mga built-in na function ay mayroon ding mga docstring sa mga ito; maaari nating gamitin ang function ng help() upang tingnan ang docstring ng mga built-in na function.
Mayroong ilang mga pagkakaiba sa pagitan ng mga komento at mga docstring. Ang mga komento ay binabalewala ng mga interpreter ngunit ang mga docstring ay hindi binabalewala ng mga interpreter. Ang memorya ay inilalaan para sa mga docstring. Ang komento ay isang paglalarawan ng code ngunit sa kabilang banda, sinasabi sa amin ng mga docstring ang layunin ng code.
Syntax:
Ang syntax para isulat ang mga docstring sa NumPy ay:
'''Docstring message'''
O kaya
'''Docstring message'''
Pakitandaan na ang docstring ay hindi isang function o paraan, kaya wala itong wastong syntax. Ang tanging bagay na dapat tandaan dito ay sinisimulan natin ang docstring na may tatlong solong panipi o tatlong dobleng panipi. Isinulat namin ang aming paglalarawan ng code at tinatapos itong muli ng tatlong solong panipi o tatlong dobleng panipi sa dulo. Walang ipinag-uutos na bagay na isulat para sa mga docstring. Kailangan mo lang maglagay ng tatlong single o double quotes bago at pagkatapos ng iyong string description.
Halimbawa 1:
Upang maunawaan ang mga docstring sa isang mas mahusay na paraan, gumawa tayo ng isang halimbawa. Sa halimbawang ito, pagkatapos isama ang NumPy library, idedeklara lang namin ang variable na 'a' at isa pang variable na 'b'. Pagkatapos nito, gagawa kami ng aming docstring na nagsasabing 'Idagdag natin ang mga variable na 'a' at 'b'. Sa aming kaso, ito ay isang madaling halimbawa ngunit kung ang aming code ay kumplikado, ito ay nakakatulong nang malaki sa coder sa pag-unawa sa code. Pagkatapos nito, ibubuod namin ang mga variable na 'a' at 'b' at iniimbak ang kanilang output na resulta sa isa pang variable na 'c'. Sa wakas, nai-print namin ang halaga ng variable na 'c'. Ngayon, isinasagawa namin ang aming code.
angkat numpy bilang hal.a = 1
b = dalawa
'''Magdagdag tayo ng a at b variable'''
c = a+b
print ( c )
Ito ang aming output mula sa ibinigay na piraso ng code. Makikita natin na ang system ay hindi nagbigay ng anumang error tungkol sa maling syntax o anumang bagay para sa line7 ng ating code. Gayundin, hindi nai-print ng system ang aming docstring. Sa halip, na-print lang nito ang output ng aming variable na 'c' kung saan sinabi namin sa aming system na mag-print. Ipinapakita nito kung paano gumagana ang mga docstring. Sa susunod, kapag sinubukan ng isang bagong coder na gawin ang aming code, mauunawaan niya kung ano ang ginagawa namin sa tulong ng aming docstring. Ngunit hindi ito ipi-print bilang output upang ang gumagamit ng code ay hindi maaabala nito.
Halimbawa 2:
Ngayon, nagsasagawa kami ng isang kumplikadong halimbawa upang maunawaan ang paggana ng docstring. Una, isinama namin ang NumPy library at pagkatapos ay sumulat ng doc string kung saan ipinapaliwanag namin ang susunod na linya ng code kung saan ipinapaliwanag namin ang pagsisimula ng array. Idinaragdag din namin ang mga docstring sa kabilang bahagi ng code. Ngayon, kung ibabahagi natin ang code na ito sa sinumang bagong developer ng Python nang hindi nagdaragdag ng mga docstring, kahit papaano ay magiging mahirap para sa kanya na malaman ang gumagana at ang layunin ng code na ito. Kailangan niyang maghanap muna tungkol sa mga function na ginamit namin. Ngunit kung magdaragdag kami ng docstring sa aming code, magiging madali para sa ibang mga developer na maunawaan ang code nang hindi nag-aaral nang higit pa tungkol sa mga function. Hindi kami pinaghihigpitan sa pagdaragdag ng mga komento sa ilang limitasyon; ang mga komento ay maaaring isa o higit sa isang linya. Maaari rin itong idagdag ng higit sa isang beses sa isang code. Pagkatapos, i-import ang NumPy bilang np.
'''Paggawa ng variable kung saan papasa tayo ng array ng laki 1x6'''array = hal. array ( [ labing-isa , 22 , 33 , 44 , 55 , 66 ] )
'''pagtatalaga ng array sa tofile() function para hayaan itong ma-save sa file na pinangalanang arr'''
array . tofile ( 'arr.bin' )
'''ipakita ang file gamit ang fromfile function'''
print ( hal. fromfile ( 'arr.bin' , dtype = int ) )
Gaya ng ipinapakita sa sumusunod na snippet, hindi ipinapakita ang mga docstring sa output na nangangahulugang hindi ito nakakaapekto sa output o compilation ng code. Ang mga docstring ay binabalewala sa panahon ng proseso ng compilation.
Konklusyon
Sa gabay na ito, natutunan namin ang tungkol sa mga docstring sa NumPy. Inihambing namin ang mga docstring sa mga komento at ipinaliwanag ang pagkakaiba sa pagitan ng dalawa. Natutunan namin ang syntax ng mga docstring at kung paano isulat ang mga docstring sa aming code. Higit pa rito, sinubukan din naming ipaliwanag kung ano ang mga docstring sa NumPy at kung paano gumagana ang mga ito sa tulong ng mga halimbawa. Sa wakas, sinabi namin na ang mga ito ay mahalaga para sa mga coder. Hindi namin uulitin ang kahalagahan ng mga docstring sa NumPy. Sasabihin lang namin na dapat mong gamitin ang mga docstring sa iyong code. Sa NumPy, ang istilo ng pagsulat ng mga docstring ay ang pinakasikat. Ito ay malawakang ginagamit sa komunidad ng programming upang ipaalam sa isa't isa ang tungkol sa paggana at paggana ng kanilang mga code. Tutulungan ka ng gabay na ito na makapagsimula sa mga docstring ng NumPy. Sinubukan naming saklawin ang karamihan sa kung ano ang kakailanganin mo gamit ang mga docstring sa NumPy.