Некоторые рекомендации по написанию комментариев в PEP8:
Комментарии должны быть законченными предложениями. happypython.ru Первое слово должно быть написано с большой буквы, если только это не имя переменной, которая начинается с маленькой буквы. happypython.ru Если комментарий короткий, можно опустить точку в конце предложения. happypython.ru
Ставить два пробела после точки в комментариях, кроме последнего предложения. sky.pro
Блочные комментарии объясняют следующий за ними участок кода. sky.pro Выравнивать их на том же уровне и начинать каждую строку с # и пробела. sky.pro Параграфы в блочных комментариях разделяются строкой с одной #. sky.pro
Не злоупотреблять комментариями на той же строке (внутренними). sky.pro Они не должны объяснять очевидных вещей и затруднять чтение кода. sky.pro Отделять их от текста как минимум двумя пробелами и начинать с # и пробела. sky.pro
Ограничить длину строки комментариев и документации 72 символами. pythonist.ru
Примеры полезных ответов Поиска с Алисой на вопросы из разных сфер. Вопросы сгенерированы нейросетью YandexGPT для актуальных тем, которые определяются на базе обобщённых запросов к Поиску с Алисой.