У овом упутству научићемо да стварамо коментаре у Питхону уз помоћ примера.
Видео: Коментари на Питхону
Коментари су описи који помажу програмерима да боље разумеју намеру и функционалност програма.
Они су потпуно игнорисани од стране тумача Питхон.
Предности коришћења коментара
Коришћење коментара у програмима чини наш код разумљивијим. Чини програм читљивијим што нам помаже да се сетимо зашто су написани одређени блокови кода.
Осим тога, коментари се такође могу користити за игнорисање неког кода током тестирања других блокова кода. Ово нуди једноставан начин да спречите извршавање неких линија или напишете брзи псеудо-код за програм.
Једноредни коментари у Питхону
У Питхону користимо хеш симбол #да напишемо једноредни коментар.
Пример 1: Писање једноредних коментара
# printing a string print('Hello world')
Оутпут
Здраво Свете
Ево, коментар је:
# printing a string
Питхон интерпретер игнорише ову линију.
Све што долази после #се занемарује. Дакле, горњи програм такође можемо написати у један ред као:
print('Hello world') #printing a string
Резултат овог програма биће исти као у примеру 1 . Тумач игнорише сав текст после #.
Вишередни коментари у Питхону
Питхон не нуди засебан начин писања вишередних коментара. Међутим, постоје и други начини за решавање овог проблема.
Можемо користити #на почетку сваког реда коментара у више редова.
Пример 2: Коришћење вишеструких #
# it is a # multiline # comment
Овде се сваки ред третира као један коментар и сви се занемарују.
Стринг Литералс за вишередне коментаре
Иако не постоји јединствени начин писања вишередних коментара у Питхону, знамо да Питхон интерпретер игнорише стринг литерале које нису додељене променљивој.
Дакле, чак можемо да напишемо једноредни коментар као:
#this is a comment 'this is an unassigned string as a comment '
Овде можемо видети да је други ред програма низ, али није додељен ниједној променљивој или функцији. Дакле, тумач игнорише низ.
На сличан начин можемо користити вишередне низове (троструке наводнике) за писање вишередних коментара.
Наводни знак може бити 'или ".
Пример 3: Коришћење Стринг Литерала за писање вишередних коментара
''' I am a multiline comment! ''' print("Hello World")
Овде вишередни низ није додељен ниједној променљивој, па га тумач игнорише. Иако технички није вишередни коментар, може се користити као један.
Питхон доцстрингс
Према договору, троструки наводници који се појављују одмах након дефиниције функције, методе или класе су доцстрингс (низови документације).
Доцстрингс су повезани са објектима и може им се приступити помоћу __doc__атрибута.
Да бисте сазнали више, посетите Питхон доцстрингс.
Како написати боље коментаре?
- Користите коментаре да бисте описали шта функција ради, а не одређене детаље о томе како функција то ради.
- Покушајте да уклоните што више сувишних коментара. Покушајте да напишете код који се може објаснити, користећи бољи избор функције / променљиве.
- Покушајте да коментари буду што краћи и сажетији.
