Вступ до коментарів на Python
Важливо зрозуміти потік програмування, що таке кодування і для чого. Як правило, для цього програміст використовує коментарі, щоб показати, для чого цей код, який метод використовується для кодування / логіки, що стоїть за ним. Ці коментарі не збираються впливати на код, але він надасть схему того, що робиться. Написання коментарів у коді допомагає покращити код, оскільки при оптимізації програміст перевіряє, що потрібно вдосконалити, і якщо коментарі показують використаний метод, оптимізувати програму буде легко. Коментарі в Python також дозволяють іншим розробникам знати та розуміти програму. Рекомендується використовувати достатню кількість коментарів, щоб код не був заплутаним при огляді назад.
Типи синтаксису в Python
У Python для коментарів використовуються два типи синтаксисів:
#: Is used to comment on one line.
Triple quotes (“): To comment more than one line.
У всіх мовах програмування визначено деякий синтаксис, щоб визначити, що є що. Програма визначається з кількома синтаксисами, наприклад, для закриття рядка в c ми використовуємо крапку з комою ';', для визначення початку класу або циклу ми використовуємо двокрапку ':'. Як видно, у нас є інший синтаксис, який є частиною коду і впливає на нього. Має бути якийсь синтаксис, який міг би сказати, що комлієр залишити коментовану частину та перейти до наступного кроку, оскільки коментарі не мають нічого спільного з результатом. Отже, дійсно дуже потрібно відрізняти коментарі від фактичного коду, щоб його не плутати з фактичною програмою.
Створення коментарів у 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? | Приклади