Въведение в коментарите в Python
От съществено значение е да разберете потока на програмирането, какво кодира и за какво. Като цяло, за да направи това, програмистът използва коментари, за да покаже за какво е това парче код, какъв метод се използва за кодиране / логиката зад него. Тези коментари няма да повлияят на кода, но ще осигурят оформление на това, което се прави. Писането на коментари в код помага за подобряване на кода, тъй като при оптимизация програмист проверява какво трябва да бъде подобрено и ако коментарите показват използвания метод, ще бъде лесно да се оптимизира програмата. Коментарите в Python също така позволяват на другите разработчици да знаят и разбират програмата. Препоръчва се използването на достатъчен брой коментари, така че кодът да не е объркващ, когато погледне назад.
Видове синтаксис в Python
В Python има два типа синтаксиси, които се използват за коментари:
#: Is used to comment on one line.
Triple quotes (“): To comment more than one line.
Във всички езици на програмиране е определен синтаксис, за да се идентифицира какво е какво. Програмата се дефинира с редица синтаксиси за напр. Затварянето на ред в c използваме запетая ';', за да определим стартирането на клас или цикъл, използваме двоеточие ':'. Както се вижда, имаме различен синтаксис, който е част от кода и го засяга. Трябва да има някакъв синтаксис, който може да каже complier да остави коментирана част и да премине към следващата стъпка, тъй като коментарите нямат нищо общо с изхода. Така че наистина е много необходимо да се разграничат коментарите от действителния код, за да не се бърка с действителната програма.
Създаване на коментари в Python
Един програмист трябва да добави коментар в програмата си, за да стане по-разбираем. Сега къде да добавя коментари? Изборът е индивидуален, но ето някои общи места, където добавянето на коментари прави програмата по-четена.
- Старт на програмата
- При определяне на параметри
- Определяне на клас
- Определяне на методи
- Логика за методите / функциите
- Описание относно процедурата
- За кръстосана проверка на изход на парче код
Следните точки са обяснени по-долу:
1. Старт на програмата
Тук един програмист дефинира какъв е проблемът и каква е нуждата на програмата.
2. При определяне на параметри
Тук програмист може да добави коментари за всеки параметър за какво стои, как ще помогне в програмата.
3. Определяне на клас
Програмата може да съдържа нула / един или повече класове, така че е важно да се определи целта на класа в началото на коментарите. Понякога се препоръчва да добавите коментари между класа, за да определите заданието на всеки ред в клас.
4. Определяне на методи
Методите са функции, които създават отношения между параметри и логика за манипулиране с него. Препоръчва се да се определи заданието на метода в коментари.
5. Логиката на методите / функциите
Като цяло, методът може да има няколко логики, прикачени към него, коментирането на описание на всяка логика може да помогне за разбирането на съществуващата логика и, ако е необходимо, може да бъде променено според изискването.
6. Описание на процедурата
За всяка програма програмист следва стъпка по стъпка процедура и определянето на стъпките на процедурата / Архитектурата на кода в коментарите може да помогне за подобряване на неговата четимост.
7. За да проверите кръстосано изхода на парче код
В редица случаи програмист трябва да направи промени в съществуващата програма. Ако една програма има редица логики и за да провери дали всички работят добре или не, той трябва да има референтен изход / Очакван изход. Коментирането на изходите от тази логика веднага след като логиката може да спести много време.
Примери за коментари в Python
Примерите са дадени по-долу:
Коментарите не оказват никакъв ефект върху изхода, както винаги, но правят програма по-четена. Ето няколко примера за коментари в python.
1. Коментиране на един ред в даден момент: Тук извършваме операция за добавяне на две променливи.
# Performing addition of two variables
a = 12 # defining variable a and its value
b = 10 # defining variable b and its value
addition = a + b # Addition logic definition
print(addition) # getting output
Изход: 22
2. Коментиране на няколко реда в даден момент: Понякога се изисква да предоставите описание на някаква логика, за която има нужда да коментирате няколко реда едновременно. Коментирането на един ред, отново и отново, може да бъде изморителна работа, така че използваме тройни кавички за това.
"""
These lines are commented to perform addition task
We will define two variables
we will apply addition logic
we will print the output
"""
a = 12
b = 10
addition = a + b
print(addition)
Изход: 22
3. Коментиране на един ред, както и на няколко реда едновременно: В повечето случаи програмист използва и двата вида коментари, за да направи програмата по-четена.
"""
These lines are commented to perform addition task
We will define two variables
we will apply addition logic
we will print the output
“””
a = 12 # defining variable a and its value
b = 10 # defining variable b and its value
addition = a + b # Addition logic definition
print(addition) # getting output
Изход: 22
Тук видяхме някои случаи на коментари, които се използват в програма. В случай на машинно обучение има различни видове модели, които се използват за прогнозиране на резултата. Човек трябва да моделира параметри, хиперпараметри и процедура, използвана в алгоритъма. Коментирането на различни подходи за модела с различни параметри може да спести повтаряемост и да спести време.
Заключение - Коментари в Python
Коментарите в дадена програма са много полезни за разбирането им. В python ние имаме основно два вида коментари или да коментираме един ред със (#) синтаксис, или да коментираме няколко реда използваме тройни кавички („). Коментарите не са там, за да повлияят на кода, а просто за добавяне на описание на това, което се кодира там и Коментарите не биха били част от изхода.
Препоръчителни статии
Това е ръководство за Коментари в Python. Тук обсъждаме Въведение, Създаване на коментари в Python са взети под внимание, Примери и Синтаксис и др. Можете също да прегледате и другите ни предложени статии, за да научите повече -
- Размяна в Python
- Python Команди
- Обратно инженерство с Python
- Размяна в С
- Променливи в JavaScript
- Обратно инженерство | Използва | Етични въпроси
- Как работят коментарите в PHP? | Примери