Python Комментарии нужны для пояснения кода программы.

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

Вот какие рекомендации содержатся в PEP 8:

Комментарии

Комментарии, противоречащие коду, хуже, чем отсутствие комментариев.

Всегда исправляйте комментарии, если меняете код!

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

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

Ставьте два пробела после точки в конце предложения.

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

Блоки комментариев

Блок комментариев обычно объясняет код (весь, или только некоторую часть), идущий после блока, и должен иметь тот же отступ, что и сам код. Каждая строчка такого блока должна начинаться с символа # и одного пробела после него (если только сам текст комментария не имеет отступа).

Абзацы внутри блока комментариев разделяются строкой, состоящей из одного символа #.

«Встрочные» комментарии

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

Такой комментарий находится в той же строке, что и инструкция. «Встрочные» комментарии должны отделяться по крайней мере двумя пробелами от инструкции. Они должны начинаться с символа # и одного пробела.

Комментарии в строке с кодом не нужны и только отвлекают от чтения, если они объясняют очевидное. Не пишите вот так:

x = x + 1                 # Increment x

Впрочем, такие комментарии иногда полезны:

x = x + 1                 # Компенсация границы

Python Комментарии исключительно рациональны и имеют ряд особенностей:

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

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

СОВЕТ Помните — комментарии нужны программисту, а не интерпретатору Python. Вставка комментариев в код позволит через некоторое время быстро вспомнить предназначение фрагмента кода.

В языке Python присутствует только однострочный комментарий. Он начинается с символа #:

# Это комментарий

Однострочный комментарий может начинаться не только с начала строки, но и располагаться после инструкции.

Например, в следующем примере комментарий расположен после инструкции, предписывающей вывести надпись «Привет, мир!»:

рrint(«Привет, мир!») # Выводим надпись с помощью функции print()

Если же символ комментария разместить перед инструкцией, то она не будет выполнена:

# рrint(«Привет, мир!») Эта инструкция выполнена не будет

Если символ # расположен внутри кавычек или апострофов, то он не является символом комментария:

print(«# Это НЕ комментарий»)

Так как в языке Python нет многострочного комментария, то часто комментируемый фрагмент размещают внутри утроенных кавычек (или утроенных апострофов):

«»»
Эта инструкция выполнена не будет
рrint(«Привет, мир!»)
«»»

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

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

Строки документирования являются «топливом» для help ():

часто для комментирования большого фрагмента кода используются утроенные кавычки или утроенные апострофы. Такие строки не являются комментариями в полном смысле этого слова. Вместо комментирования фрагмента создаётся объект строкового типа, который сохраняется в атрибуте _doc_.

Функция help () при составлении документации получает информацию из этого атрибута. Такие строки называются строками документирования.

Приглашаю всех высказываться в Комментариях. Критику и обмен опытом одобряю и приветствую. В хороших комментариях сохраняю ссылку на сайт автора!

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