Python как пишется комментарий

Документирование кода на ранних этапах разработки имеет гораздо большее значение, чем может показаться на первый взгляд. Эта тема также связана с добавлением полезных комментариев к коду. Когда вы погружаетесь в разработку программы, вы можете неосознанно присвоить своим переменным и функциям весьма странные и непонятные названия. Таким образом, через некоторое время, вернувшись к коду, вы потратите огромное количество времени, пытаясь разобраться, что к чему.

Содержание статьи

• Комментарии в коде
• Как закомментировать и раскомментировать строки кода
• Многострочные комментарии
• Для чего используется docstring?
• PEP 8 — руководство по написанию кода на Python
• Полезные инструменты для документирования вашего кода
• Подведем итоги
• Вопросы для проверки

Делая свой код самодокументирующимся (то есть используя информативные имена) и добавляя комментарии, вы сделаете программу более читабельной для себя и для всех остальных, кто может её использовать. Это также облегчит обновление и рефакторинг кода!

В данной статье вы познакомитесь со следующими темами:

• Комментарии;
• Строки документации — Docstrings;
• PEP8 — Руководство по написанию кода;
• Другие полезные инструменты для документирования вашего кода.

Давайте начнем с комментариев.

Комментарии — это подсказки, которые предназначены для вас, а не для компьютера. Комментарий это, по сути, заметка, которая объясняет, что происходит в рассматриваемой части кода. Они используются, чтобы объяснить, почему вы что-то сделали или как работает тот или иной фрагмент кода. Когда вы только начинаете программировать, будет не лишним оставлять много комментариев, к которым можно будет потом вернуться. Как только вы научитесь правильно и удобно именовать свои функции и переменные, вы поймете, что многие комментарии вам больше не нужны.

Тем не менее, комментарии все равно рекомендуется использовать. Они особенно полезны для сложного кода, который нелегко понять с первого взгляда. В зависимости от компании, в которой вы работаете, вы также можете использовать комментарии для документирования багов. Например, если вы исправили ошибку, вы можете добавить комментарий, который объясняет, в чем именно она заключается.

В Python комментарии создаются с помощью знака #, за которым следует какой-либо описательный текст.

Далее представлен пример комментария в Python:

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

Этот комментарий помечен как «плохой комментарий». Хотя он хорош для демонстрационных целей, но он не описывает код, который следует далее. По этой причине он не является полезным. Хорошие комментарии должны объяснять и описывать последующий код, его цели или что-то еще. Комментарии — это своеобразная документация вашего кода. Если они не предоставляют никакой полезной информации, то их следует удалить.

Вы также можете создавать комментарии на строке с кодом:

Здесь вы снова присваиваете переменной x значение 10, но затем добавляете символ #, который позволяет добавить комментарий к коду. Это полезно в тех случаях, когда необходимо объяснить конкретную строку кода. Если вы назвали свою переменную каким-то логическим и интуитивно понятным именем, то, скорее всего, комментарий вообще не понадобится.

В будущем вы довольно часто будете сталкиваться с таким понятием, как «закомментированный код«. Это практика добавления символа # в начале вашего кода. Таким образом, можно на всякий случай убрать какой-то кусок кода, сделав его на данный момент нерабочим.

К примеру, у вас может быть следующая строка кода:

Если вы хотите закомментировать её, это можно сделать следующим образом:

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

Горячие клавиши для комментирования куса кода: (выделить нужный участок кода) +  Ctrl + /

Некоторые языки программирования, к примеру С++, предоставляют возможность создания многострочных комментариев. Для создания многострочных комментариях вы спокойно можете использовать тройные кавычки.

Далее представлен пример многострочного комментария на Python:

При использовании строк с тройным кавычками вы можете создать docstring (строки документации). По сути, мы уже это сделали когда добавили многострочный комментарии для функции test().

Давайте выясним, что это такое, и как оно используется!

Для чего используется docstring?

В Python существует концепция PEP, или Python Enhancement Proposal. PEP представляют собой предложения или новые возможности для языка Python, которые обсуждаются и согласовываются руководящим советом Python.

PEP 257 описывает соглашения о docstring. Вы можете прочитать его, если вам нужна более подробная информация. Если обобщить, то docstring — это строковый литерал, который должен быть сразу после определения названия для модуля, функции, класса или метода.

docstring создается с помощью трех двойных кавычек.

Рассмотрим пример:

В Python docstring игнорируются. Они не могут быть выполнены. Однако, когда вы добавляете docstring к модулю, функции и так далее, то данная строка становится специальным атрибутом, к которому можно получить доступ через __doc__.

Результат:

docstring можно использовать как для однострочных, так и для многострочных строк.

Далее дан пример однострочной строки:

Однострочная docstring является простой строкой текста.

Далее представлена строка docstring, используемый в функции:

В приведенном выше коде показано, как можно добавить docstring в функцию. Хорошая строка docstring описывает, что должна сделать функция.

На заметку: Хотя три двойные кавычки являются рекомендуемым стандартом, три одинарные кавычки, одни двойные кавычки и одни одинарные кавычки также работают (но одни двойные и одинарные кавычки могут содержать только одну строку, а не несколько).

Теперь давайте узнаем о создании программы в соответствии с руководством по написанию кода на Python.

PEP 8 — руководство по написанию кода на Python

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

Руководство по написанию кода Python было создано еще в 2001 году и получило название PEP8. В нем указаны соглашения по программированию на языке Python. За прошедшие годы текст несколько раз обновлялся.

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

Однако запомнить все правила может быть непросто. К счастью, некоторые бесстрашные разработчики создали определенные утилиты, которые могут помочь!

Полезные инструменты для документирования вашего кода

Существует множество инструментов, которые можно использовать для написания отличного кода. Вот всего несколько из них:

• pycodestyle — Проверяет, если ваш код соответствует стандарту PEP8;
• Pylint — Инструмент для углубленного статического тестирования кода, который находит общие проблемы в коде;
• PyFlakes — Еще один инструмент для статического тестирования кода;
• flake8 — Обертка для PyFlakes, pycodestyle и McCabe;
• Black — Форматировщик кода, который в основном следует стандарту PEP8.

Вы можете использовать эти инструменты, чтобы найти проблемные места в вашем коде. Pylint, PyFlakes и flake8 кажутся мне наиболее полезными. Black пригодится, если вы работаете в команде и хотите, чтобы код каждого сотрудника был написан в одном формате. Можете добавить Black в свой список инструментов форматирования кода.

Более продвинутые IDE для Python делают определенные проверки в режиме реального времени. Например, PyCharm автоматически проверяет многие проблемы, которые фиксируют эти инструменты. WingIDE и VS Code также обеспечивают некоторую проверку кода. Можете просто попробовать различные IDE и посмотреть, что подойдет вам лучше всего.

Подведем итоги

В Python есть несколько различных способов документирования кода. Вы можете использовать комментарии, чтобы объяснить одну или несколько строк кода. Их следует использовать умеренно и по мере необходимости. Вы также можете использовать docstring, чтобы документировать модули, функции, методы и классы.

Вам также следует ознакомиться с руководством по программированию на Python, которое можно найти в PEP8. Это поможет разобраться в принципах хорошего программирования на Python. Существует несколько других руководств по стилю написания кода на Python. Например, руководство по стилю от Google или руководство по стилю Python от NumPy. Иногда ознакомление с различными руководствами может помочь развить свой собственный хороший стиль программирования.

Мы также познакомились с несколькими инструментами, которые можно использовать для улучшения вашего кода. Если у вас есть время, я советую вам ознакомиться с PyFlakes или Flake8, так как они могут помочь найти общие проблемы в вашем коде.

Предыдущий урок: Инструкции и выражения

Добавление комментариев считается хорошей практикой. Это неисполняемые, но все равно важные части кода. Они не только помогают программистам, работающим над одним и тем же проектом, но также тестировщикам, которые могут обращаться к ним для ясности при тестировании белого ящика.

Куда лучше добавлять комментарии при создании или обновлении программы, иначе можно утратить контекст. Комментарии, добавленные позже, могут быть далеко не настолько эффективными.

Комментарии — это способ выражения того, что делает программа на самом высоком уровне. Это отмеченные строчки, которые комментируют код. В Python они бывают двух типов: одно- и многострочные.

Такой тип комментариев нужен для написания простых, быстрых комментариев во время отладки. Такие комментарии начинаются с символа решетки # и автоматически заканчиваются символом окончания строки (EOL).

# Хороший код документируется
print("Изучите Python шаг за шагом!")

При добавлении комментария важно убедиться, что у него тот же уровень отступа, что и у кода под ним. Например, нужно оставить комментарий к строке объявления функции, у которой нет отступа. Однако они имеются у блоков кода внутри нее. Поэтому учитывайте выравнивание при комментировании внутренних блоков кода.

# Создадим список месяцев

months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',

                'Jul','Aug','Sep','Oct','Nov','Dec']


# Функция вывода календарных месяцев

def showCalender(months):

    # Цикл for проходит по списку и вводит название каждого месяца

    for month in months:

        print(month)



  


                       
  





showCalender(months)

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

Python позволяет писать комментарии на нескольких строках. Они называются многострочными или блочными. Такой тип комментирования подходит для описания чего-то более сложного.

Этот тип комментариев нужен для описания всего последующего кода. Дальше примеры многострочных комментариев в Python.

С помощью символа #

Для добавления многострочного комментария нужно начинать каждую строку с символа решетки и одного пробела. Такой комментарий можно разбить на абзацы. Для этого достаточно добавлять пустые строки с символом перед каждым из них.

Примечание: в оригинале этот символ (#) называется octothorpe,
что переводится с латинского как «восемь концов».
Термин придумала группа инженеров в Bell Labs,
которая работала над проектом первой сенсорной клавиатуры.

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

# 1. Знать синтаксис, типы данных, структуры и условные операторы.

# 2. Изучить обработку ошибок и ввод/вывод.

# 3. Читайте о продвинутых структурах данных.

# 4. Пишите функции и следуйте концепциям ООП.


def main():

    print("Начнем изучать Python.")

Docstring в Python

В Python есть такая особенность, как задокументированные строки (docstring). С их помощью программисты могут быстро добавлять комментарии для каждого модуля, функции, метода или класса в Python.

Задать docstring можно с помощью строковой константы. Она обязана быть первой инструкцией в определении объекта.

У docstring более широкая область применения, чем у комментария. Она должна описывать, что делает функция, а не как. Хорошей практикой считается добавление таких строк в каждую функцию программы.

Как задать docstring в Python?

Задать docstring в Python можно с помощью тройных кавычек Нужно добавить один набор в начале и еще один – в конце. Docstring также могут занимать по несколько строк.

Примечание: строки с тремя кавычками также являются docstring в Python, пусть они и могут казаться обычными комментариями.

В чем отличие между комментарием и docstring?

Строки, начинающиеся с тройной кавычки, — это все еще обычные строки, которые могут быть написаны в несколько строк. Это значит, что они все еще являются исполняемыми инструкциями. Если же у них нет метки, значит сборщик мусора уничтожит их после исполнения.

Интерпретатор Python не будет игнорировать их так же, как комментарии. Но если такая строка расположена сразу же после объявления функции или класса в верхней части модуля, то она станет docstring. Получить к ним доступ можно следующим образом — myobj.__doc__.

def theFunction():

    '''

    Эта функция демонстрирует использование docstring в Python.

    '''

    print("docstring python не являются комментариями.")


print("nВыведем docstring функции...")

print(theFunction.__doc__)

Выводы

Комментарии и docstring добавляют ценности программе. Они делают программы более читаемыми и пригодными для последующей поддержки. Даже при рефакторинге сделать это будет намного проще с комментариями.

Разработка программного обеспечения — это лишь на 10% написание кода. Остальные 90% — поддержка.

Поэтому всегда добавляйте осмысленные комментарии и docstring, потому что они упрощают процесс взаимодействия и ускоряют процесс рефакторинга.

Далее: Приоритетность операторов

Comments are text notes added to the program to provide explanatory information about the source code. They are used in a programming language to document the program and remind programmers of what tricky things they just did with the code and also help the later generation for understanding and maintenance of code. The compiler considers these as non-executable statements. Since comments do not execute, when you run a program you will not see any indication of the comment in the output.

Syntax: The hash(#) symbol denotes the starting of a comment in Python.  

# This is a comment in Python

Example:

Output :  

GFG

Comments should be made at the same indent as the code it is commenting on.

Hello!!
GeeksforGeeks
Welcome to Comments in Python

Types of Comments

1. Single-Line Comments: Comments starting with a ‘#’ and whitespace are called single-line comments in Python. These comments can only stretch to a single line and are the only way for comments in Python. e.g.

# This a single line comment.

2. Multi-line (Block) comments: Unlike other programming languages Python doesn’t support multi-line comment blocks out of the box. However we can use consecutive # single-line comments to comment out multiple lines of code. Some examples of block comments-

# This type of comments can serve
# both as a single-line as well
# as multi-line (block) in Python.

3. Inline Style comments: Inline comments occur on the same line of a statement, following the code itself. Generally, inline comments look like this:

x = 3        # This is called an inline comment

a = b + c    # Adding value of 'b' and 'c' to 'a'

4. Docstring comments: Python documentation strings (or docstrings) provide a convenient way of associating documentation with Python modules, functions, classes, and methods. It’s specified in source code that is used, like a comment, to document a specific segment of code. Unlike conventional source code comments, the docstring should describe what the function does, not how.

Example: 

Output: 

Using __doc__:
Demonstrates docstrings and does nothing really.
Using help:
Help on function my_function in module __main__:

my_function()
    Demonstrates docstrings and does nothing really.

Advantages and Uses of Comments:

Planning and reviewing: In the comments, we can write the pseudocode which we planned before writing the source code. Pseudocode is a mixture of natural language and high-level programming language. This helps in reviewing the source code more easily because pseudocode is more understandable than the program. 

Example:

Output :

13

Debugging: The brute force method is a common method of debugging. In this approach, print statements are inserted throughout the program to print the intermediate values with the hope that some of the printed values will help to identify the errors. After doing debugging we comment on those print statements. Hence comment is also used for debugging.

 
Output :

True

Comments are text notes added to the program to provide explanatory information about the source code. They are used in a programming language to document the program and remind programmers of what tricky things they just did with the code and also help the later generation for understanding and maintenance of code. The compiler considers these as non-executable statements. Since comments do not execute, when you run a program you will not see any indication of the comment in the output.

Syntax: The hash(#) symbol denotes the starting of a comment in Python.  

# This is a comment in Python

Example:

Output :  

GFG

Comments should be made at the same indent as the code it is commenting on.

Hello!!
GeeksforGeeks
Welcome to Comments in Python

Types of Comments

1. Single-Line Comments: Comments starting with a ‘#’ and whitespace are called single-line comments in Python. These comments can only stretch to a single line and are the only way for comments in Python. e.g.

# This a single line comment.

2. Multi-line (Block) comments: Unlike other programming languages Python doesn’t support multi-line comment blocks out of the box. However we can use consecutive # single-line comments to comment out multiple lines of code. Some examples of block comments-

# This type of comments can serve
# both as a single-line as well
# as multi-line (block) in Python.

3. Inline Style comments: Inline comments occur on the same line of a statement, following the code itself. Generally, inline comments look like this:

x = 3        # This is called an inline comment

a = b + c    # Adding value of 'b' and 'c' to 'a'

4. Docstring comments: Python documentation strings (or docstrings) provide a convenient way of associating documentation with Python modules, functions, classes, and methods. It’s specified in source code that is used, like a comment, to document a specific segment of code. Unlike conventional source code comments, the docstring should describe what the function does, not how.

Example: 

Output: 

Using __doc__:
Demonstrates docstrings and does nothing really.
Using help:
Help on function my_function in module __main__:

my_function()
    Demonstrates docstrings and does nothing really.

Advantages and Uses of Comments:

Planning and reviewing: In the comments, we can write the pseudocode which we planned before writing the source code. Pseudocode is a mixture of natural language and high-level programming language. This helps in reviewing the source code more easily because pseudocode is more understandable than the program. 

Example:

Output :

13

Debugging: The brute force method is a common method of debugging. In this approach, print statements are inserted throughout the program to print the intermediate values with the hope that some of the printed values will help to identify the errors. After doing debugging we comment on those print statements. Hence comment is also used for debugging.

 
Output :

True

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

Инструкции

Инструкции, которые может выполнять интерпретатор Python, называются операторами. Например, a = 1 — это оператор присваивания. Оператор if, оператор for, оператор while и т. д. — это другие типы операторов, которые мы обсудим позже.

Многострочные инструкции

В Python для окончания инструкции используют символ новой строки. Но можно разбить инструкцию на несколько строк символом продолжения строки (). Например:

a = 1 + 2 + 3 + 
    4 + 5 + 6 + 
    7 + 8 + 9

Это явное продолжение строки. В Python продолжение строки выполняется внутри круглых ( ), квадратных [ ] и фигурных скобок { }. Например, так мы можем реализовать показанную выше многострочность:

a = (1 + 2 + 3 +
    4 + 5 + 6 +
    7 + 8 + 9)

Здесь круглые скобки ( ) неявно продолжают строку. То же самое с [ ] и { }. Например:

colors = ['красный',
          'голубой',
          'зеленый']

Мы также можем поместить несколько выражений в одну строку с помощью точки с запятой, как показано ниже:

a = 1; b = 2; c = 3

Отступы

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

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

Как правило, для отступов используют четыре пробела или табуляцию. Вот пример:

for i in range(1,11):
    print(i)
    if i == 5:
        break

Применение отступов в Python делает код аккуратным и чистым. Программы благодаря отступам выглядят последовательными. С ними блоки кода визуально легче отличать друг от друга. 

Сравните:

if True:
    print('Привет')
    a = 5

и

if True: print('Привет'); a = 5

Оба варианта допустимы и сделают одно и то же, но первый вариант — читабельнее.

Неправильный отступ приведет к ошибке IndentationError.

Комментарии

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

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

В Python для комментариев используется символ решетки (#).

Комментарий заканчивается символом новой строки. Интерпретатор Python игнорирует комментарии.

#Это комментарий
#выводим «Привет»
print('Привет')

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

В Python можно использовать многострочные комментарии. Один из способов — использовать символ решетки (#) в начале каждой строки. Например:

#Это длинный комментарий,
#и он продолжается
#на несколько строк

Можно поступить иначе — использовать тройные кавычки: ''' или """.

Тройные кавычки обычно используются для многострочных строк. Но их также можно использовать для многострочных комментариев. Если они не являются строками документации, они не создают никакого дополнительного кода.

"""Это тоже
пример прекрасного
многострочного комментария"""

Строки документации (docstrings) в Python

Docstring — это сокращение от documentation string (строка документации).

Строки документации в Python — это строковые литералы, которые появляются сразу после определения функции, метода, класса или модуля.

При написании строк документации используются тройные кавычки. Например:

def double(num):
    """Функция, которая удваивает значение"""
    return 2*num

Строки документации появляются сразу после определения функции, класса или модуля. Это и отличает их от многострочных комментариев, написанных с использованием тройных кавычек.

Строка документации связана с объектом как его атрибут __doc__.

Так что мы можем получить доступ к строкам документации функции с помощью следующих строк кода:

def double(num):
    """Функция, которая удваивает значение"""
    return 2*num
print(double.__doc__)

Вывод:

Функция, которая удваивает значение

Комментарии являются неотъемлемой частью любой программы. Каждый язык программирования позволяет добавлять комментарии. Система комментирования Python очень проста.

• Комментарии Python начинаются с символа # и продолжаются до конца строки.
• Мы можем начать комментарий с начала строки после некоторых пробелов или кода.
• Если символ решетки присутствует в строковом литерале, он является частью строки.

Примеры

• Комментарий для переменных

name = "Pankaj"  # employee name
id = 100  # employee id

data = "#123"  # this is comment, data contains # and that is not part of the comment.

• Комментарии к функциям

# This function adds the two numbers
def add(x, y):
    return x+y

• для класса

# This class provides utility functions to work with Strings
class StringUtils:

    def reverse(s):
        return ''.join(reversed(s))

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

Иногда невозможно разместить комментарий в одной строке. В этом случае вы можете разбить на несколько строк. Для написания многострочного комментария необходимо ставить перед каждой строкой решётку (#).

# This class provides utility functions to work with Strings
# 1. reverse(s): returns the reverse of the input string
# 2. print(s): prints the string representation of the input object
class StringUtils:

    def reverse(s):
        return ''.join(reversed(s))
    
    def print(s):
        print(s)

Использование строки документации

Строки документации Python (Docstring) используются для предоставления документации для функций, классов и модулей. Они заключены в пару тройных двойных кавычек («»»). Они должны быть определены сразу после объявления функции или класса.

Давайте кратко рассмотрим несколько примеров строк документации Python.

def foo():
    """The foo() function needs to be implemented.
    Currently, this function does nothing."""
    pass


class Data:
    """ This class is used to hold Data objects information."""

Мы можем получить доступ к строке документации объекта, используя атрибут __doc__ .

print(foo.__doc__)
print(Data.__doc__)

Можно ли использовать строку документации для указания длинных многострочных комментариев?

Целью строк документации Python является предоставление документации. Иногда вы заметите, что это неправильно для длинных комментариев. Однако это не рекомендуемый подход. Если вы хотите, чтобы комментарий разбился на несколько строк, просто добавьте к каждой строке символ решетки.

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

Мы также можем использовать многострочную строку в качестве многострочного комментария. Они не генерируют код.

'''
This function read employees data from the database
emp_id: employee id, should be int
returns employee object.
'''
def read_emp_from_db(emp_id):
    i = int(emp_id)
    '''code to read emp data
    using the employee unique id number'''
    pass

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

Советы

• Всегда предоставляйте содержательные комментарии, чтобы указать использование объекта.
• Длинный комментарий лучше разбить на несколько строк.
• Не грубите в комментариях.
• Должны быть по существу. Никто не хочет читать роман в комментариях к коду.
• Избегайте бесполезных комментариев, не содержащих полезной информации. Ниже приведены несколько примеров бесполезных.

# count variable
count = 10

# foo() function
def foo():
    pass

• Иногда в комментариях нет необходимости. Достаточно иметь собственное имя самой сущности. Давайте посмотрим на пример этого сценария.

# This function add two numbers
def foo(x, y):
    return x + y


# Better to have function defined as below. There is no use of comments.

def add_two_numbers(x, y):
    return x + y

• Всегда полезно иметь систему комментариев. При работе с большим количеством членов команды и несколькими проектами в организации рекомендуется использовать политику. Например, вы можете определить такую политику:

# {Object Type} - {Usage}
# Data Object - stores the Data fetched from the database
data_obj = Data()


# {Function Short Description}
# {Input Arguments and their types}
# {Return object details}
# {Exception Details}

# This function adds all the elements in the sequence or iterable
# numbers: sequence or iterable, all the elements must be numbers
# Returns the sum of all the numbers in the sequence or iterable
# Throws ArithmeticError if any of the element is not a number


def add_numbers(numbers):
    sum_numbers = 0
    for num in numbers:
        sum_numbers += num
    return sum_numbers

Вывод

• Система комментариев Python проста и всегда начинается с символа #.
• Строка документации предназначена для документации. Не используйте его для многострочных комментариев.
• Для многострочных комментариев начинайте каждую строку с символа решетки.
• Следуйте рекомендациям по добавлению комментов в программу.
• Наличие политики — всегда хорошая идея при работе с большим количеством членов команды.