Питхон доцстринг

Документација је неопходна за свако програмирање да би се лако разумео код. Користи се за објашњење сврхе употребе било које изјаве или функције или класе или модула у програму. Помаже главном кодеру да памти функцију било ког кода након дужег времена, а такође помаже и другим кодерима који желе да раде на истом пројекту. Кодер користи један ред коментара да би укратко објаснио одређени део функције кода. Низ Питхон документа или низ докумената користе се за детаљно објашњење функције одређеног сегмента кода. Ред доцстринга треба да започиње великим словом, а завршава тачком. Први ред доцстринга садржи кратак опис документације уопште. Други ред доцстринг-а требао би бити празан за велики доцстринг више линија. Троструки појединачни наводници ('”) или троструки двоструки наводници (“” ”) користе се за дефинисање доцстринг-а у Питхону. Садржају доцстринга може се приступити коришћењем тхе __доц__ атрибут објекта и коришћење помоћ() метода. Начин декларисања и приступа документима у Питхону приказан је у овом упутству.

Пример-1: Приступ доцстринг-у функције помоћу __доц__ атрибут

Начин декларисања и приступа документу прилагођене функције приказан је у следећој скрипти. Следећа скрипта израчунава к^н при чему ће се кориснику узети к и н. Снага () функција је у скрипти дефинисала извршавање задатка. Овде је доцстринг дефинисан за ову функцију. __доц__ атрибут је кориштен у скрипти за испис доцстринга са излазом.

деф снага (к, н):
„Израчунајте к до степена н
Прочитајте вредности к и н из аргумената функције
и израчунати и вратити вредност к у степен н."
ретурн к ** н
# Узмите вредност к
к = инт (инпут ('Унесите вредност к:'))
# Узмите вредност н
н = инт (инпут ('Унесите вредност н:'))
# Одштампајте повратну вредност функције
принт ("% д до потенције% д =% д"% (к, н, снага (к, н)))
# Одштампајте вредност доцстринг-а
принт ("Садржај доцстринга: \ н" + снага.__доц__)

Излаз:

Следећи излаз ће се појавити након извршавања горње скрипте.

Пример-2: Приступ документима класе и методе помоћу помоћ() метода

Начин декларисања и приступа документима документа и методе те класе приказани су у следећој скрипти. Главна функција скрипте је сортирање нумеричке листе и поништавање података са листе. У класи је декларисана нумеричка листа од 8 елемената, а доцстринг је дефинисан на почетку класе помоћу троструких појединачних наводника. У класи је дефинисана метода сорт_лист () за испис сортираних података листе, а документ је то дефинисао за овај метод. реверсе_лист () метода је дефинисана за испис обрнутих података листе, а за овај метод је дефинисана и доцстринг. помоћ() метода је позвала три пута на крају скрипте да испише доцстринг датотеке лист_оператионс класа, сорт_лист () метода и реверсе_лист () метода.

цласс лист_оператионс:

цласс лист_оператионс:
"
Сортирање и обртање података листе
Час садржи две методе,
метода сорт_лист () ће сортирати и одштампати листу,
метода сорт_реверсе () ће преокренути и исписати листу.
"
# Дефинишите листу нумеричких података
листдата = [23, 67, 23, 6, 45, 3, 90, 11]
деф сорт_лист (селф):
"
Одштампајте вредности листе након сортирања
Функција ће из аргумента узети објект листе нумеричких података,
сортирајте вредности листе методом сорт ()
и одштампајте вредности сортиране листе.
"
# Сортирај листу
себе.листдата.врста()
# Штампање сортиране листе помоћу петље
принт ("Вредности сортиране листе: \ н")
за вредност у себи.листдата:
испис (вредност, "", крај = ")
деф реверсе_лист (селф):
"
Одштампајте вредности листе након вожње уназад
Функција ће из аргумента узети објект листе нумеричких података,
преокрене вредности листе помоћу методе реверсе ()
и одштампајте вредности обрнуте листе.
"
# Обрни листу
себе.листдата.обрнуто ()
# Испишите обрнуту листу помоћу петље
принт ("Вредности сортиране листе: \ н")
за вредност у себи.листдата:
испис (вредност, "", крај = ")
# Одштампајте вредност доцстринга класе
помоћ (лист_оператионс)
# Креирајте објекат класе
обј = лист_оператионс ()
# Одштампајте вредност доцстринга одређене методе
помоћ (обј.сорт_лист)
# Позовите метод за испис сортиране листе
обј.сорт_лист ()

Излаз:

Следећи излаз ће се појавити након извршавања скрипте. Сва доцстринг скрипта је одштампана први пут помоћ() функцију. Документација сорт_лист () метода је одштампана за другу помоћ() функцију.

Пример-3: Приступ документима уграђеног Питхон модула

У претходним примерима, доцстринг је коришћен у кориснички дефинисаној класи и функцији. Сваки уграђени Питхон модул и класа има свој низ докумената који објашњава сврху коришћења тог одређеног модула или функције. Кодирање модула или функције дефинише низ докумената како би код био разумљив корисницима. Следећа скрипта ће исписати унапред дефинисану доцстринг модула датетиме помоћу помоћ() функцију.

# Увоз модула за датум и време
импорт датетиме
# Прикажите доцстринг датума и времена
помоћ (датум и време)

Излаз:

Следећи излаз ће се појавити након извршавања скрипте. Документација модула датума и времена приказује детаљну документацију о њему како би помогла осталима да правилно знају функције класа и метода дефинисаних у овом модулу.

Закључак:

Правилна документација је од кључне важности када се било који модул или функција имплементира за одређену сврху како би се помогло другом кодеру да користи модул у њиховом коду за обављање одређеног задатка. Ако документација није правилно дефинисана за модул или функцију, остали корисници ће се суочити са проблемима када је користе. Дакле, сваки кодер мора да користи доцстринг документа како би пружио детаљне информације осталима да би разумели код.