В този урок ще се научим да създаваме коментари в Python с помощта на примери.
Видео: Коментари в Python
Коментарите са описания, които помагат на програмистите да разберат по-добре намерението и функционалността на програмата.
Те са напълно игнорирани от интерпретатора на Python.
Предимства на използването на коментари
Използването на коментари в програмите прави нашия код по-разбираем. Това прави програмата по-четлива, което ни помага да запомним защо са написани определени блокове код.
Освен това, коментарите могат да се използват и за игнориране на някои кодове, докато се тестват други блокове код. Това предлага лесен начин да се предотврати изпълнението на някои редове или да се напише бърз псевдокод за програмата.
Едноредови коментари в Python
В Python използваме символа хеш, за #да напишем едноредов коментар.
Пример 1: Писане на едноредови коментари
# printing a string print('Hello world')
Изход
Здравей свят
Тук коментарът е:
# printing a string
Този ред се игнорира от интерпретатора на Python.
Всичко, което идва след това, #се игнорира. Така че, можем също да напишем горната програма в един ред като:
print('Hello world') #printing a string
Резултатът от тази програма ще бъде същият като в пример 1 . Преводачът игнорира целия текст след #.
Многоредови коментари в Python
Python не предлага отделен начин за писане на многоредови коментари. Има обаче и други начини да заобиколите този проблем.
Можем да използваме #в началото на всеки ред коментар по няколко реда.
Пример 2: Използване на множество #
# it is a # multiline # comment
Тук всеки ред се третира като отделен коментар и всички те се игнорират.
String Literals за многоредови коментари
Въпреки че няма уникален начин за писане на многоредови коментари в Python, знаем, че интерпретаторът на Python игнорира низовите литерали, които не са присвоени на променлива.
Така че, дори можем да напишем едноредов коментар като:
#this is a comment 'this is an unassigned string as a comment '
Тук можем да видим, че вторият ред на програмата е низ, но не е присвоен на променлива или функция. Така че, интерпретаторът игнорира низа.
По подобен начин можем да използваме многоредови низове (тройни кавички), за да напишем многоредови коментари.
Цитатният знак може да бъде 'или ".
Пример 3: Използване на String Literals за писане на многоредови коментари
''' I am a multiline comment! ''' print("Hello World")
Тук многоредовият низ не е присвоен на никоя променлива, така че той се игнорира от интерпретатора. Въпреки че технически не е многоредов коментар, той може да се използва като един.
Доктринг на Python
По споразумение тройните кавички, които се появяват веднага след дефиницията на функция, метод или клас, са docstrings (документални низове).
Докстрингите са свързани с обекти и могат да бъдат достъпни с помощта на __doc__атрибута.
За да научите повече, посетете документите на Python.
Как да напиша по-добри коментари?
- Използвайте коментари, за да опишете какво прави функцията, а не конкретните подробности за това как функцията го прави.
- Опитайте се да премахнете колкото се може повече излишни коментари. Опитайте да напишете код, който може да се обясни, като използвате по-добър избор на име на функция / променлива.
- Опитайте се да направите коментарите възможно най-кратки и кратки.
