Комментарии в Python - Создание комментариев в Python

Введение в комментарии в 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. Для перекрестной проверки вывода кода

Следующие пункты были объяснены ниже:

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, примеры, синтаксис и т. Д. Вы также можете просмотреть другие предлагаемые нами статьи, чтобы узнать больше -

1. Обмен в Python
2. Команды Python
3. Обратный инжиниринг с Python
4. Обмен в C
5. Переменные в JavaScript
6. Обратный инжиниринг | Использует | Этические вопросы
7. Как комментарии работают в PHP? | Примеры