Пошто већ знамо како да напишемо вишелинијске коментаре, можемо користити или троструке једноструке наводнике или троструке двоструке наводнике. Документациони низ користимо када желимо да опишемо наше функције тако да можемо да добијемо документацију када нам је потребна. Неки ИДЕ вам дају документацију тако што пређете мишем преко имена, а неки истичу одређене кључне речи. Али чињеница је да су низови докумената у НумПи-у много флексибилнији него у другим језицима. Доцстринг је стринг литерал који се јавља на почетку дефиниције функције. Морамо да обезбедимо специфичне вредности док користимо низове докумената у случајевима функција, класа итд.
Када користимо низове докумената са функцијама, морамо проследити аргументе. Када их користимо са класама, ми прослеђујемо атрибуте и методе. У случају модула, морамо да обезбедимо листу класа и функција. У случају пакета, преносимо листу модула са функционалношћу. Дакле, у основи, сврха доцстринг-а је, као што име објашњава, да помаже у документацији нашег кода. Ми радимо документацију тако да ако неко користи наш код у будућности, може да разуме наш код и логику иза нашег кода уз помоћ доцстринг-а. Уграђене функције такође имају низове докумената у себи; можемо користити функцију хелп() да погледамо доцстринг уграђених функција.
Постоји неколико разлика између коментара и низова докумената. Преводиоци игноришу коментаре, али тумачи не занемарују низове докумената. Меморија се додељује за документе. Коментар је опис кода, али с друге стране, низови докумената нам говоре сврху кода.
Синтакса:
Синтакса за писање низова докумената у НумПи је:
'''Доцстринг порука'''
Ор
'''Доцстринг порука'''
Имајте на уму да доцстринг није функција или метода, тако да нема одговарајућу синтаксу. Једина ствар коју треба приметити је да доцстринг почињемо са три појединачна или три двострука наводника. Пишемо наш опис кода и завршавамо га поново са три једнострука или три двострука наводника на крају. Не постоји обавезна ствар за писање за документе. Само треба да ставите три једнострука или двострука наводника пре и после описа стринга.
Пример 1:
Да бисмо боље разумели низове докумената, хајде да изведемо пример. У овом примеру, након укључивања НумПи библиотеке, једноставно декларишемо променљиву „а“ и другу променљиву „б“. Након тога, креирамо наш доцстринг који каже „Хајде да додамо „а“ и „б“ променљиве“. У нашем случају, ово је једноставан пример, али ако је наш код сложен, то много помаже кодеру у разумевању кода. Након тога, сабирамо променљиве „а“ и „б“ и чувамо њихов резултат у другој променљивој која је „ц“. На крају, штампамо вредност променљиве „ц“. Сада извршавамо наш код.
увоз нумпи као на пример.а = 1
б = два
'''Хајде да додамо а и б променљиве'''
ц = а+б
принт ( ц )
Ово је наш излаз из датог дела кода. Видимо да систем није дао ниједну грешку о нетачној синтакси или било чему за ред 7 нашег кода. Такође, систем није одштампао наш доцстринг. Уместо тога, штампао је само излаз наше променљиве „ц“ у којој смо рекли нашем систему да штампа. Ово показује како функционишу документи. Следећи пут, када нови кодер покуша да ради на нашем коду, разумеће шта радимо уз помоћ нашег доцстринг-а. Али неће бити одштампан као излаз тако да корисник кода неће бити узнемирен тиме.
Пример 2:
Сада изводимо сложен пример да бисмо разумели рад доцстринга. Прво укључујемо НумПи библиотеку, а затим пишемо доц стринг у којем објашњавамо следећи ред кода где објашњавамо иницијализацију низа. Такође додајемо низове докумената у другом делу кода. Сада, ако поделимо овај код са било којим новим Питхон програмером без додавања низова докумената, биће му некако тешко да зна рад и сврху овог кода. Прво мора да тражи функције које смо користили. Али ако нашем коду додамо низ докумената, другим програмерима ће бити лако да разумеју код без проучавања више о функцијама. Нисмо ограничени на додавање коментара уз одређена ограничења; коментари могу бити од једног или више од једног реда. Такође се може додати више пута у код. Затим увезите НумПи као нп.
'''Креирање променљиве којој ћемо проследити низ величине 1к6'''низ = на пример. низ ( [ Једанаест , 22 , 33 , 44 , 55 , 66 ] )
'''додељивање низа функцији тофиле() да би се он сачувао у датотеци под називом арр'''
низ . да поднесе ( 'арр.бин' )
'''прикажи датотеку користећи функцију фромфиле'''
принт ( на пример. фромфиле ( 'арр.бин' , дтипе = инт ) )
Као што је приказано у следећем исечку, низови докумената се не приказују у излазу што значи да не утиче на излаз или компилацију кода. Докстрингови се занемарују током процеса компилације.
Закључак
У овом водичу смо научили о низовима докумената у НумПи-у. Упоредили смо низове докумената са коментарима и објаснили разлику између њих. Научили смо синтаксу низова докумената и како да напишемо низове докумената у нашем коду. Штавише, покушали смо да објаснимо шта су доцстрингс у НумПи-у и како функционишу уз помоћ примера. Коначно, приметили смо да су они неопходни за кодере. Нећемо понављати важност низова докумената у НумПи-у. Рећи ћемо само да треба да користите документе у свом коду. У НумПи-у, стил писања низова докумената је најпопуларнији. Широко се користи у програмској заједници да једни друге знају о раду и функционалности њихових кодова. Овај водич ће вам помоћи да почнете са НумПи документима. Покушали смо да покријемо већину онога што ће вам требати користећи низове докумената у НумПи-у.