Комментарии

Комментарий Python - это важный инструмент для программистов. Комментарии обычно используются для пояснений в коде. Мы можем легко понять код, если он имеет правильное пояснение. Хороший программист должен использовать комментарии, потому что в будущем кто-нибудь захочет изменить код, а также внедрить новый модуль; тогда это легче можно будет сделать.

В других языках программирования, таких как C++, предусмотрены // для однострочного комментария и /*.... */ для многострочного комментария, но Python предоставляет однострочный комментарий с помощью символа #.

Давайте разберем следующий пример.

# This is the print statement  
print("Hello Python")  

Здесь мы написали комментарий поверх оператора print, используя хэш(#). Это не повлияет на наш оператор print.

Многострочный комментарий Python

Мы должны использовать хэш(#) в начале каждой строки кода, чтобы применить многострочный комментарий Python. Рассмотрим следующий пример.

# First line of the comment   
# Second line of the comment  
# Third line of the comment  

# Variable a holds value 5  
# Variable b holds value 10  
# Variable c holds sum of a and b  
# Print the result  
a = 5  
b = 10  
c = a+b  
print("The sum is:", c)  

Вывод:

The sum is: 15

Приведенный выше код очень хорошо читается, даже новички могут понять, что происходит в каждой строке кода. В этом и заключается преимущество использования комментариев в коде.

Мы также можем использовать тройные кавычки ('''''') для многострочного комментария. Тройные кавычки также используются для форматирования строк. Рассмотрим следующий пример.

Комментарии Docstrings в Python

Комментарий docstring чаще всего используется в модуле, функции, классе или методе. Мы расскажем о классе/методе в дальнейших уроках.

def intro():  
  """ 
  This function prints Hello Joseph 
  """  
  print("Hi Joseph")              
intro()  

Вывод:

Hello Joseph

Мы можем проверить задокументированную строку в функции с помощью атрибута __doc__.

def intro():  
  """ 
  This function prints Hello Joseph 
  """  
  print("Hello Joseph")              
intro.__doc__  

Вывод:

Output:
'\n  This function prints Hello Joseph\n  '

Отступы в Python

Отступы в Python используются для определения блока кода. Другие языки программирования, такие как C, C++ и Java, используют фигурные скобки {}, в то время как Python использует отступ. В качестве отступа в Python используются пробельные символы.

Отступы используются в начале кода и заканчиваются ненулевой строкой. Этот же отступ от строки определяет блок кода (тело функции, цикла и т.д.).

Обычно в качестве отступа используется четыре пробельных символа. Величина отступа зависит от пользователя, но она должна быть одинаковой во всем блоке.

for i in range(5):  
    print(i)  
    if(i == 3):  
        break  

Чтобы обозначить блок кода, мы отступили от каждой строки блока на одинаковые пробелы.

Рассмотрим следующий пример.

dn = int(input("Enter the number:"))  
if(n%2 == 0):  
    print("Even Number")  
else:  
    print("Odd Number")  
     
print("Task Complete")  

Вывод:

Enter the number: 10
Even Number
Task Complete

Приведенный выше код, if и else - это два отдельных блока кода. Оба блока кода имеют отступ в четыре пробела. Оператор print("Task Complete") не имеет отступа в четыре пробела и находится вне блока if-else.

Если отступ используется неправильно, то это приведет к ошибке IndentationError.