питон комментарии в коде
№28 Как писать комментарии / для начинающих
Добавление комментариев считается хорошей практикой. Это неисполняемые, но все равно важные части кода. Они не только помогают программистам, работающим над одним и тем же проектом, но также тестировщикам, которые могут обращаться к ним для ясности при тестировании белого ящика.
Куда лучше добавлять комментарии при создании или обновлении программы, иначе можно утратить контекст. Комментарии, добавленные позже, могут быть далеко не настолько эффективными.
Комментарии — это способ выражения того, что делает программа на самом высоком уровне. Это отмеченные строчки, которые комментируют код. В Python они бывают двух типов: одно- и многострочные.
Однострочные комментарии в Python
Такой тип комментариев нужен для написания простых, быстрых комментариев во время отладки. Такие комментарии начинаются с символа решетки # и автоматически заканчиваются символом окончания строки (EOL).
При добавлении комментария важно убедиться, что у него тот же уровень отступа, что и у кода под ним. Например, нужно оставить комментарий к строке объявления функции, у которой нет отступа. Однако они имеются у блоков кода внутри нее. Поэтому учитывайте выравнивание при комментировании внутренних блоков кода.
Многострочные комментарии в Python
Python позволяет писать комментарии на нескольких строках. Они называются многострочными или блочными. Такой тип комментирования подходит для описания чего-то более сложного.
Этот тип комментариев нужен для описания всего последующего кода. Дальше примеры многострочных комментариев в Python.
С помощью символа #
Для добавления многострочного комментария нужно начинать каждую строку с символа решетки и одного пробела. Такой комментарий можно разбить на абзацы. Для этого достаточно добавлять пустые строки с символом перед каждым из них.
Примечание: в оригинале этот символ (#) называется octothorpe, что переводится с латинского как «восемь концов». Термин придумала группа инженеров в Bell Labs, которая работала над проектом первой сенсорной клавиатуры.
Docstring в Python
В Python есть такая особенность, как задокументированные строки (docstring). С их помощью программисты могут быстро добавлять комментарии для каждого модуля, функции, метода или класса в Python.
Задать docstring можно с помощью строковой константы. Она обязана быть первой инструкцией в определении объекта.
У docstring более широкая область применения, чем у комментария. Она должна описывать, что делает функция, а не как. Хорошей практикой считается добавление таких строк в каждую функцию программы.
Как задать docstring в Python?
Задать docstring в Python можно с помощью тройных кавычек Нужно добавить один набор в начале и еще один – в конце. Docstring также могут занимать по несколько строк.
Примечание: строки с тремя кавычками также являются docstring в Python, пусть они и могут казаться обычными комментариями.
В чем отличие между комментарием и docstring?
Строки, начинающиеся с тройной кавычки, — это все еще обычные строки, которые могут быть написаны в несколько строк. Это значит, что они все еще являются исполняемыми инструкциями. Если же у них нет метки, значит сборщик мусора уничтожит их после исполнения.
Как правильно писать комментарии в Python
Комментарии в Python – важный инструмент для программистов. Комментарии обычно используются для объяснения кода. Мы можем легко понять код, если у него есть правильное объяснение. Хороший программист должен использовать комментарии, потому что в будущем кто-то захочет изменить код, а также реализовать новый модуль; тогда это можно сделать легко.
В другом языке программирования, таком как C ++, используются: // – для однострочного комментария и / * …. * / – для многострочного комментария, но Python предоставляет однострочный комментарий. Чтобы применить комментарий в коде, мы используем решётку(#) в начале оператора или кода.
Давайте разберемся в следующем примере.
Здесь мы написали комментарий к оператору печати с помощью решетки(#). Это не повлияет на наш оператор печати.
Многострочный комментарий Python
Мы должны использовать решётку(#) в начале каждой строки кода, чтобы применить многострочный комментарий Python. Рассмотрим следующий пример.
Приведенный выше код очень удобочитаем, даже абсолютные новички могут понять, что происходит в каждой строке кода. В этом преимущество использования комментариев в коде.
Мы также можем использовать тройные кавычки(” ” ”) для многострочного комментария. Тройные кавычки также используются для форматирования строк. Рассмотрим следующий пример.
Комментарий строки документации
Комментарий к строке документации в основном используется в модуле, функции, классе или методе. Это строка документации Python. Мы объясним класс / метод в следующих руководствах.
Hello Joseph
Мы можем проверить строку документации функции с помощью атрибута __doc__.
Обычно в качестве отступа используются четыре пробела. Размер отступа зависит от пользователя, но он должен быть одинаковым во всем блоке.
Примечание. Строка документации должна быть первой в функции; в противном случае интерпретатор Python не сможет получить строку документации.
Отступы Python
Отступы Python используются для определения блока кода. Другие языки программирования, такие как C, C ++ и Java, используют фигурные скобки <>, тогда как Python использует отступы. Пробелы используются в Python как отступ.
Отступ используется в начале кода и заканчивается непреднамеренной строкой. Тот же отступ строки определяет блок кода(тело функции, цикл и т. д.)
Обычно в качестве отступа используются четыре пробела. Размер отступа зависит от пользователя, но он должен быть одинаковым во всем блоке.
Чтобы обозначить блок кода, мы выделили каждую строку блока одними и теми же пробелами.
Рассмотрим следующий пример.
Приведенный выше код, if и else – два отдельных блока кода. Оба блока кода имеют отступ в четыре пробела. Оператор print(«Задача завершена») не имеет отступа в четыре пробела и находится вне блока if-else. Если отступ используется неправильно, это приведет к ошибке IndentationError.
Комментирование Python кода
Программирование отражает ваш образ мышления, чтобы описать отдельные шаги, которые вы предприняли для решения проблемы с помощью компьютера. Комментирование вашего кода помогает объяснить ваш мыслительный процесс, а также помогает вам и другим людям понять смысл вашего кода. Это позволяет вам легче находить ошибки, исправлять их, впоследствии улучшать код, а также повторно использовать его и в других приложениях.
Комментирование важно для всех видов проектов, независимо от того, маленькие они, средние или довольно большие. Это важная часть вашего рабочего процесса, и считается хорошей практикой для разработчиков. Без комментариев все может запутаться, очень быстро. В этой статье мы расскажем о различных методах комментирования, поддерживаемых Python, и о том, как его можно использовать для автоматического создания документации для вашего кода с использованием так называемых строк документации уровня модуля.
Хорошие против плохих комментариев
Как бы ни были важны комментарии, все еще можно писать плохие комментарии. Они всегда должны быть короткими, прямолинейными и добавлять информативную ценность.
Например, это довольно бесполезный комментарий:
Следующий пример демонстрирует более полезный комментарий и дает переменным очевидные имена:
Типы комментариев
В следующих разделах я опишу каждый тип комментария.
Однострочные комментарии
Такой комментарий начинается с хеш-символа ( # ) и сопровождается текстом, который содержит дополнительные пояснения.
Вы также можете написать комментарий рядом с оператором кода. Следующий пример показывает, это:
Руководство по стилю для кода Python ( PEP8 ) рекомендует менее 79 символов на строку. На практике 70 или 72 символа в строке легче читать, и поэтому рекомендуется. Если ваш комментарий приближается к этой длине или превышает ее, тогда вы захотите распределить его по нескольким строкам.
Многострочные комментарии
Как уже упоминалось выше, весь блок комментариев также понимается Python. Эти комментарии служат встроенной документацией для других, читающих ваш код, и обычно объясняют вещи более подробно
Технически Python не имеет явной поддержки многострочных комментариев, поэтому некоторые варианты считаются обходным решением, но все же работают для многострочных комментариев.
Версия 1 объединяет однострочные комментарии следующим образом:
Версия 2 проще, чем версия 1. Изначально она предназначалась для создания документации (подробнее об этом ниже), но ее также можно использовать для многострочных комментариев.
Обратите внимание, что последняя версия должна быть заключена в специальные кавычки ( «»» ) для работы, а не хеш-символы.
Обычная практика
Довольно часто начинать Python-файл с нескольких строк комментариев. В этих строках указывается информация о проекте, назначении файла, программисте, который его разработал или работал над ним, и лицензии на программное обеспечение, которое используется для кода.
Этот фрагмент взят из одного из примеров, которые я использую в учебных целях. Комментарий начинается с описания, за ним следует уведомление об авторских правах с моим именем и год публикации кода. Ниже вы увидите, что код лицензирован под GNU Public License ( GPL ). Для того, чтобы связаться со мной, мой адрес электронной почты также добавлен туда.
Комментарии документации
Python имеет встроенную концепцию под названием «строки документации», которая является отличным способом связать написанную вами документацию с модулями, функциями, классами и методами Python. Строка документа добавляется в качестве комментария прямо под заголовком функции, модуля или объекта и описывает действия функции, модуля или объекта. Ожидается, что будут следовать этим правилам:
Начните строку документа с заглавной буквы и завершите ее точкой.
Это основной пример того, как это выглядит:
Существует ряд инструментов, которые автоматически генерируют документацию из строк документации, таких как Doxygen, PyDoc, pdoc и расширение autodoc для Sphinx. Мы объясним вам, как работать с ними в следующей статье.
Заключение
Написание правильных комментариев в вашем коде Python не так сложно, и вам просто нужна сила выносливости. Это помогает всем, кто пытается понять ваш код, включая вас самих, когда вы в следующий раз вернетесь к нему. Мы надеемся, что совет, который мы дали вам здесь, облегчит вам создание более качественных комментариев и документации в вашем коде.
Комментарии в коде языка Python
Как комментировать код
Комментарии, которые противоречат коду, хуже, чем отсутствие комментариев. Всегда делайте приоритет обновления комментариев при изменении кода!
Комментарии должны быть полными предложениями. Первое слово должно быть написано заглавными, если только это не идентификатор, который начинается со строчной буквы (никогда не меняйте регистр идентификаторов!).
Блочные комментарии обычно состоят из одного или нескольких абзацев, построенных из полных предложений, причем каждое предложение заканчивается точкой.
Вы должны использовать два пробела после окончания каждого предложения в комментариях из нескольких предложений, за исключением последнего предложения.
При написании английского, следуйте Strunk и White.
Python программисты из стран, не говорящих по-английски: пишите свои комментарии на английском языке, если уверены на 120%, что код никогда не будет прочитан людьми, которые говорят на вашем языке.
Блок комментариев:
Блочные комментарии обычно применяются к некоторому (или всему) коду, который следует за ними, и имеют отступ на том же уровне, что и комментируемый код. Каждая строка комментария блока начинается с # и одного пробела (если только внутри комментария нет отступа).
Встроенные комментарии:
Используйте встроенные комментарии экономно.
Встроенные комментарии не нужны и фактически отвлекают, если они утверждают очевидное. Не делай этого:
Строки документации:
Условные обозначения для написания хорошей документации описаны в PEP 257.
Для строк документации в одну строку, пожалуйста, сохраняйте закрывающий символ «»» на этой же строке.
Использование комментариев в Python
В этом руководстве мы обсудим что такое комментарии, зачем они нужны и как правильно записывать многострочные и однострочные комментарии в языке программирования Python.
Введение
По мере того, как ваши программы становятся все длиннее и сложнее, следует добавлять в код заметки, поясняющие подход, используемый вами для решения поставленной задачи.
Комментарии позволяют писать заметки и пояснять код прямо внутри программы.
Комментарии используются там, где код недостаточно понятен сам по себе. По сути, это операторы или строки, игнорируемые интерпретаторами Python.
Снабжая программу комментариями, вы делаете код более читабельным для людей, поскольку это в удобной форме поясняет назначение того или иного блока или строчки кода.
В зависимости от назначения программы, комментарии могут выполнять роль личных заметок или списков задач, которые еще предстоит выполнить, либо их можно писать для других программистов, чтобы тем было проще понять, как работает ваш код.
Как правило, лучше всего писать комментарии по ходу дела, пока вы пишете или обновляете программу – если вернуться к их написанию позже, вы можете уже не вспомнить ход своих мыслей в тот момент, и в долгосрочной перспективе такие комментарии могут оказаться менее полезными.
Создание комментария
Чтобы написать комментарий, начните строку с символа #. Python проигнорирует все, что будет написано после него. Как правило, комментарии выглядят примерно так:
Комментарии также можно размещать в конце строки:
Многострочные комментарии
В Python нет отдельного синтаксиса для многострочных комментариев. Однако, равноценного результата можно добиться, используя многострочную строку:
Если строка не привязана к какой-либо переменной, Python прочитает ее как код, но в итоге проигнорирует.
Пример использования
Иногда программисты, работающие с Python, ставят символ # перед строчкой кода, чтобы временно удалить ее из программы на время проверки. Этот прием называется «закомментировать код» и пригождается в тех случаях, когда вы пытаетесь выяснить, почему программа не работает. Закончив проверки, вы можете быстро вернуть код обратно, просто удалив поставленный перед строчкой символ #.
Заключение
Писать комментарии в коде Python – очень полезная привычка, и даже если на данный момент вы не видите в этом необходимости, то поверьте: пояснения к работе различных участков кода могут понадобиться как программистам, его читающим, так и лично вам, если вы вернетесь к работе над программой после долгого перерыва.
Это особенно полезно в том случае, если ваш код является открытым или выложен на GitHub, где другие программисты пытаются его дополнить. Подробно ознакомив их с тем, что вы уже успели сделать, вы поможете им быстрее освоиться и начать работу.