Писање добрих коментара у Питхон-у ће омогућити другим програмерима и тестерима да лако читају и разумеју ваш код.
Чист код са доследном синтаксом, описним именовањем променљивих и увлачењем је попут прве књиге, лакши за разумевање и одржавање.
Осим тога, ових дана је мање уобичајено да појединац напише комплетан код за целу апликацију или софтвер; него ће тим или група људи радити на истом циљу. У овом случају, чист и читљив код чини сарадњу једноставнијом и ефикаснијом.
Програмери и тестери увек имају за циљ да примене софтвер без грешака у производњу. Писање чистог и читљивог кода убрзава овај процес чинећи отклањање грешака једноставнијим и прецизнијим. Иако нађете неке грешке у производњи, чистији код је лакше ажурирати.
Што је још важније, чист и читљив код живи дуже јер код остаје свеж како време пролази.
Коначно, кључно је имати чист и читљив код за креирање дуготрајног софтвера. Али поставља се питање како то тачно постићи? Па, један метод је коришћење коментара.
Није ли фрустрирајуће када сте написали цео код за сложену логику, али следећег дана, када не можете да наставите тамо где сте стали? Ово се не дешава када пишете коментаре.
Коментари су људски језик који објашњава шта изворни код ради. Можете их написати на било ком језику, по могућности на енглеском, пошто је то глобални језик.
Дакле, кад год се вратите свом изворном коду након неколико дана или чак година, коментари ће вам објаснити шта сте једном написали.
Такође, помажу другим програмерима да лако разумеју ваш код. Зато код написан уз коментаре остаје заувек, чак и у одсуству свог аутора.
Штавише, прилично је уобичајено да имате сукобе када радите са различитим програмским језицима, посебно када радите у тиму. Ту у помоћ прискачу коментари. Иако не знате програмски језик изворног кода који је написао ваш саиграч, коментари вам помажу да разумете логику иза тога.
Документација кода је свеобухватнији начин одржавања изворног кода и омогућава вашем тиму да неприметно сарађује. Садржи све о коду, попут дизајна, функционалности, архитектуре, компоненти, итд.,
Коментари чак доприносе овој документацији кода. Добро написани коментари се могу директно пренети у документацију кода, тако да програмери не само да добију шта и зашто, већ и како за ваш код.
- Коментари не само да читају код, већ вам такође помажу да разумете намеру програмера иза сваке линије. Дакле, ако пронађете неку грешку у будућности, знаћете где тачно да ажурирате код.
- Можете написати коментаре као параграф за цео код или појединачне линије објашњавајући шта сваки блок кода ради. На овај начин омогућавају вама и другим програмерима да добро разумете код, побољшавајући читљивост.
- Коментари могу поделити код на логичке делове, чинећи навигацију кодом једноставнијом.
- Требало би да укључите коментаре са детаљима очекиваних улаза, излаза и случајева коришћења како би тестер могао да прочита ваш код.
- Коначно, стављањем добро написаних коментара у вашу документацију побољшава се укупна читљивост документације кода.
Коментари у Питхон-у почињу хеш (#) симболом. Дакле, када започнете ред са хешом (#), онда се све што је написано у том реду третира као коментар.
Када покренете код, компајлер игнорише ред који почиње са хешом (#) као да чак и не постоји. Међутим, коментари остају видљиви у изворном коду да би служили својој сврси.
Постоје три главна типа.
Ово су они које сте видели горе. Почињу симболом хеш (#). У основи, ред који почиње хеш (#) симболом је посвећен коментару. Дакле, ово се зове коментар у једном реду, где можете написати коментар само у једном реду који почиње са хешом (#).
Ево како можете писати коментаре у једном реду
# This is single line comment.
Технички, Питхон не подржава вишелинијске коментаре, али постоје начини да се то постигне у Питхон-у.
Такође можете користити хеш (#) за писање коментара у више редова. Сваки ред који напишете треба да почиње хеш (#) симболом овде.
# This is the first comment. # This is second comment. # This is the last comment.
Преглед садржаја
#3. Питхон Доцстрингс
Популаран начин писања вишелинијских коментара је коришћење стринг литерала – “””….”””. Када напишете нешто између троструких наводника, Питхон компајлер игнорише те редове и извршава преостали део у датотеци.
Ови коментари се називају доцстрингс када су написани одмах након функција, модула и класа.
Ево синтаксе за ово
""" Multi-line comments using docstrings in Python. """
Писање јасних и детаљних коментара побољшава читљивост и одржавање кода. Дакле, ево најбољих пракси за јасно коментарисање у Питхон-у.
Коментари не би требало да само приповедају шта код ради, већ би требало да одражавају сврху и намеру иза сваке линије.
Уклоните застареле коментаре и обавезно ажурирајте коментаре кад год мењате код.
Уместо дугих прича, пишите кратке и конкретне коментаре.
Bad example: The function takes a,b as input, calculates a + b, and returns the value. Good example: The function returns the sum of a and b.
Коришћење смислених и описних имена за променљиве и имена функција може елиминисати сувишне коментаре.
Прво код? Или прво коментаришите? Коментирање пре кодирања је најбоља пракса; односно напишите своје коментаре и затим одговарајући код. На овај начин, прво можете смислити логику, а затим је претворити у код.
# Returns true if the cnt is less than 1. return cnt < 1
Користите конзистентан формат коментара као што су размак, увлачење, тип коментара итд., за цео код. Ово ће бити мање збуњујуће и више организовано за читаоце.
Користите низове докумената да бисте објаснили функције и класе у Питхон-у као што је приказано у следећем примеру.
def add_num(a,b):
""" this function returns the sum of a and b """
sum = a+b
return sum
Избегавајте непотребне коментаре у свом коду. На пример, следећи ред кода не треба коментар да би га разумео.
ans = 42
#1. Висуал Студио Цоде Едитор
Висуал Студио Цоде Едитор је најбољи ИДЕ који је направио Мицрософт за комплетно развојно окружење. Са изворном подршком за Ноде.јс и ЈаваСцрипт, алат такође подржава многе друге програмске језике неприметно.
Овај веома прилагодљив алат има различита проширења за различите функционалности. „Бољи коментари“ је једно такво проширење које вам омогућава да креирате коментаре прилагођене људима.
Своје коментаре можете категоризовати у упозорења, упите, истакнуте ставке, итд., ради лакше навигације.
ВС код подржава уређивање са више курсора тако да можете коментарисати или уређивати више редова истовремено.
Овај уређивач је доступан на свим главним платформама као што су Мац, Виндовс и Линук.
#2. Сублиме Тект
Сублиме Тект је главни уредник за велике пројекте и тешко кодирање. Уредник је познат по својој брзини, прилагођавању и пречицама.
Моћна функција истицања синтаксе алата помаже вам да лако разликујете код и коментаре.
Попут ВС кода, Сублиме тект такође подржава уређивање са више курсора за коментарисање више редова у исто време.
Захваљујући функцији аутоматског довршавања. Не морате ручно понављати редове кода; ова функција аутоматски довршава ваш код на основу образаца, помажући вам да брже кодирате.
Штавише, функција алатке ‘Гото Анитхинг’ вам омогућава да се неприметно пребацујете између функција и датотека вашег пројекта.
#3. Нотепад++
Нодепад++ је популаран и једноставан уређивач текста написан у Ц++ и подржава бројне програмске језике. Не изгледа као модеран уређивач као што је ВС Цоде или Сублиме Тект; његов интерфејс је врло једноставан и изгледа као да ради оно што треба.
Нодепад++ нуди бројне стандардне пречице за ефикасно коментарисање. Такође можете да прилагодите тастатуру за пречице да бисте персонализовали своје искуство коментарисања.
Његова функција мапе докумената вам показује преглед структуре пројекта, омогућавајући вам да се крећете по датотекама, фасциклама и коду неприметно.
#4. Вим
Вим ИДЕ обезбеђује бржи развој и извршавање кода. Све и свашта се може урадити у овом уређивачу помоћу пречица на тастатури, тако да би требало да се озбиљно потрудите да га савладате.
Овај уређивач усмерен на тастатуру такође нуди многе функције за коментарисање путем пречица на тастатури. Има моћне функције и команде за ефикасно кретање по коментарима.
Овај лагани софтвер може да обрађује огромне датотеке и стотине програмских језика. Ко мрзи бесплатне ствари? Као и сви уредници на листи, Вим је такође потпуно бесплатан и отвореног кода.
Долази у мацОС и Линук системима и може се преузети на Виндовс-у.
#5. ПиЦхарм
ПиЦхарм је моћан ИДЕ који је посебно дизајниран за развој Питхон-а. Иако подржава многе друге програмске језике, најбоље функционише за Питхон. Има довршавање кода, истицање синтаксе и функције за отклањање грешака прилагођене Питхон-у.
Штавише, то чини коментарисање у Питхон-у много ефикаснијим. Пружа функције навигације које вам помажу да лако пређете на одређене коментаре.
Набавите различите шаблоне коментара и ефикасно креирајте прилагођене шаблоне коментара у Пицхарму.
Такође, уређивачки алати за рефакторисање вам омогућавају да лако ажурирате или поправите коментаре.
Закључак
Праћење стандарда кода је неопходно током целог процеса развоја кода и обавезно за писање кода спремног за производњу, јер ваш код треба да читају сви други програмери и тестери.
Једна важна пракса за креирање читљивог кода је писање коментара. Коментари су доступни у скоро свим програмским језицима. Међутим, са овим чланком сада би требало да знате како да пишете Питхон коментаре, њихове типове и најбоље праксе које треба следити приликом писања коментара.
Такође, наведени су најбољи уређивачи кода који вам помажу у управљању коментарима.