как закомментировать код в python горячие клавиши
Комментирование кода в Python (Урок №5)
Прежде чем двигаться далее, изучим короткую, но важную тему комментирования кода в Python.
Бывает так, что программист написал программу, отложил ее в сторону на несколько дней, а потом с удивлением понимает, что уже и не помнит, что там нагородил =)
На самом деле, это частая ситуация. Я сам регулярно возвращаюсь к своим старым программам и радуюсь (но не всегда), что комментировал собственный код.
И, как результат, я быстрее понимаю, что сам и написал =)
Что такое комментирование кода?
Если кратко, то это поясняющие записи, к тем или иным командам. Можно провести аналогию с заметками на полях книги.
Но прежде чем продолжить далее, отмечу, что можете посмотреть видео (в нем больше информации, по понятным причинам), или прочитать текстовую версию чуть ниже.
Не забудьте подписаться на мой Youtube-канал.
Как комментировать код в Python?
При этом, интерпретатор Python игнорирует все символы, которые находятся после # и до конца строки.
Обратите внимание, что можно не только оставлять полезные заметки, поясняющие работу программу, но и временно «блокировать» выполнение той или иной команды.
Если мы запустим код выше на выполнение, то получим 8 (результат сложения переменных d = b + c).
Но так как две строки
закомментированы, то они не будут исполняться интерпретатором. И мы не увидим на экране, какие значения у переменных b и c.
Это полезная фича, когда тестируется программа, или ищут ошибки в коде.
Но в финальном варианте программы, разумеется, закомментированные команды лучше удалить, чтобы не засорять код командами, которые не используются при работе программы.
При этом поясняющие комментарии лучше оставить.
Понятно, что не нужно комментировать абсолютно все команды. Но важные моменты, или те, что нельзя сразу понять, лучше пояснить.
Как сразу закомментировать много строк кода?
Бывает так, что нужно сразу закомментировать много строк кода, которые временно нужно исключить. Если вручную ставить в начале каждой строки знак #, то можно быстро разозлиться.
К счастью, большинство редакторов кода позволяют это сделать быстро.
Например, если используете PyCharm, то достаточно выделить нужный блок кода и нажать сочетание клавиш CTRL + /
Если нужно раскомментировать много строк кода, то опять выделяем нужные строки и снова нажимаем сочетание клавиш CTRL + /.
Как писать комментарии в Python?
Как написать комментарии в Python?
Комментарий в Python начинается с символа хеша # и продолжается до конца физической строки. Однако хеш-символ внутри строкового значения не рассматривается как комментарий.
Как пишутся многострочные комментарии в Python?
Для добавления многострочного комментария нужно начинать каждую строку с символа решетки и одного пробела. Такой комментарий можно разбить на абзацы. Для этого достаточно добавлять пустые строки с символом перед каждым из них.
Как закомментировать сразу несколько строк Python?
Какой символ позволяет оставлять комментарии в коде программе?
Многострочный комментарий может иметь любую длину, он отмечается специальными символами в начале и конце (например, /* */ ). Некоторые языки позволяют вложение многострочных комментариев, другие — нет. Однострочный комментарий отмечается специальным символом в начале (например, // ) и продолжается до конца строки.
Как сделать комментарий в PyCharm?
Какие имена переменных правильные Python?
Правила именования переменных:
Как закомментировать строки в Visual Studio?
Visual Studio Code
Как закомментировать сразу несколько строк?
Также CTRL + K хорошо работает в Notepad ++, чтобы комментировать. Если у вас были комментарии в длинном блоке, который вы комментируете, CTRL + Q раскомментирует ваши фактические комментарии, где CTRL + K просто добавьте еще один уровень // впереди. CTRL + SHIFT + K удаляет однострочный комментарий из выделения.
Что такое закомментировать строки?
Функция Закомментировать позволяет вставить символ # в начале строки, чтобы указать, что при обработке эту строку следует игнорировать. Аналогичным образом можно раскомментировать закомментированную строку, с тем чтобы эта строка была включена в обработку.
Как закомментировать блок кода?
Как закомментировать весь код в Python?
Как закомментировать несколько строк JS?
Используйте горячие клавиши! В большинстве редакторов строку кода можно закомментировать, нажав комбинацию клавиш Ctrl+/ для однострочного комментария и что-то вроде Ctrl+Shift+/ – для многострочных комментариев (выделите кусок кода и нажмите комбинацию клавиш).
Для чего нужны комментарии в коде?
Комментарии — поясняющие строки в программном коде, которые позволяют понять смысл написанного. Они пишутся для людей, но игнорируются компиляторами и интерпретаторами.
Для чего используются комментарии в программе?
Они предназначены для того, чтобы пояснять какую-нибудь сложную и непонятную часть вашей программы. Кроме того, иногда их используют, чтобы на время отключить какую-то часть кода. Это возможно потому, что всё что записано в комментарии компилятор игнорирует.
Как делать комментарии в С ++?
Комментарии в C++ записываются одним из следующих способов:
Шпаргалка: Горячие (hotkeys) клавиши PhpStorm и PyCharm
Горячих клавиш в IDE PhpStorm и PyCharm гораздо больше, чем в приведенном ниже списке. Здесь я привел только те, которыми пользуюсь сам (* звездочкой выделил наиболее используемые мною горячие клавиши).
Шпаргалка будет обновляться, если начну использовать новые hotkeys.
Для настройки горячих клавиш или добавление собственных сочетаний клавиш перейдите File > Settings > Keymap.
Редактирование
*Ctrl + W — выделение текущего блока. Если нажимать W несколько раз, то будут выделяться родительские блоки по иерархии.
Ctrl + Shift + W — проделывает обратное действие от предыдущего
Ctrl + Y — удаляет строку
*Ctrl + D — дублирует строку
Ctrl + Shift + U — делает выделенный текст или заглавными, или строчными буквами
Ctrl + Delete — удаляет часть от курсора до конца слова
*Ctrl + Alt + L — форматирование кода соответствии с настройками code style.
*Ctrl + / — закомментировать/раскомментировать текущую строку.
Ctrl + Shift + / — закомментировать/раскомментировать выделенные строки кода.
Ctrl + Shift + J — к текущей строке присоединяет нижнюю.
Ctrl + [ или ] — перемещает курсор в начало или конец блока с кодом, в теле фукции, в теле цикла и т.д.
Ctrl + Shift + ] или [ — выделить код код до конца или до начала блока
*Tab — сделать отступ (табуляцию)
*SHIFT + Tab — убрать отступ
*Ctrl + Alt + Стрелка вверх — перемещает текущую строку вверх.
*Ctrl + Alt + Стрелка вниз — перемещает текущую строку вниз.
Ctrl + Shift + Стрелка вниз — перемещает текущий логический блок вниз
*Ctrl + Space — выводит возможные варианты автодополнения
Ctrl + курсор мыши над кодом — краткая информация
*Ctrl + клик по названию переменной или метода, или CTRL+B когда курсор установлен на названии, приведет туда, где метод или переменная определены.
*Ctrl + G — перейти к строке по номеру
*Alt + Клик левой кнопкой мышки — мультикурсор, если нужно одновременно несколько курсоров, кликаем мышкой в нужные места, куда нужно их добавить
*Ctrl + Alt + J — обрамление выделенного текста тегом (нужно выбрать первый пункт из всплывающего окошка)
F11 — быстро установить закладку
Shift + F11 — просмотр всех закладок
Поиск / замена
Двойной Shift — поиск по проекту
*Ctrl + F — поиск в текущем файле
*Ctrl + R — поиск и замена
*Ctrl+Shift+E — вызовет всплывающее окно, в котором показаны последние куски кода в разных файлах, с которыми вы работали
Ctrl + Shift + F — поиск в группе файлов (например в проекте или папке)
Ctrl + Shift + R — поиск и замена в группе файлов
Ctrl + N — найти в каком файле находится класс
*Ctrl + Shift + N — поиск файла по названию
Разное
Ctrl + Alt + S — быстрый доступ к настройкам
*Shift + F6 — переименование файла (выделите в блоке с файлами проекта нужный файл).
Комментирование 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 не так сложно, и вам просто нужна сила выносливости. Это помогает всем, кто пытается понять ваш код, включая вас самих, когда вы в следующий раз вернетесь к нему. Мы надеемся, что совет, который мы дали вам здесь, облегчит вам создание более качественных комментариев и документации в вашем коде.
О некоторых горячих клавишах в PyCharm
Хочу поделиться с вами горячими клавишами, которыми пользуюсь или к которым пытаюсь привыкнуть в своей повседневной работе. В современных средах их количество может просто зашкаливать, но постепенное добавление новых сочетаний в копилку, способно значительно повысить вашу продуктивноть. Приведенные сочетания относятся к редактированию, навигации, рефакторингу и справедливы только для раскладки Default for XWin (Linux).
Ctrl+Alt+Left/Ctrl+Alt+Right
На одном из лидирующих позиций (в моем рейтинге) находится перемещение назад и вперед. Если кто-то пользовался emacs, то функционал напоминает marks and mark ring. При определенных командах перемещения по файлу в историю добавляются новые позиций, по которым и происходит перемещение.
Ctrl+Shift+Backspace
Перемещение к месту последней правки. В принципе, это частный случай предыдущей команды, но тем не менее полезный.
Ctrl+B
Многим известное перемещение к реализации.
Двойное нажатие Shift
Поиск по индексу, который включает в себя имена файлов, имена классов, их атрубиты и т.д. Также есть отдельные команды:
Ctrl+N — для классов, Ctrl+Shift+N — для файлов и Ctrl+Alt+Shift+N — для символов (функций, атрибутов классов).
Ctrl+Shit+6
Именованые метки для быстрого перемещения по «горячим» местам. Перемещение к метке — Ctrl+5.
Удаление метки — повторное нажатие Ctrl+Shift+5.
Ctrl+W
Выделение кода с учетом синтаксиса. Очень полезная фича.
Alt+Shift+Down/Alt+Shift+Up
Перемещение строки, на которой установлен курсор вверх или вниз. Есть аналогичная команда, но только для целых
statements — Ctrl+Shift+Down/Ctrl+Shift+Down.
Ctrl+Y
Удаление всей строки. Кстати, команда копирования Ctrl+C без выделения также работает для всей строки.
Ctrl+D
Продублировать текущую строку.
Ctrl+Alt+V
Вынесение выделенного выражения в переменную. Замечательно работает в сочетании с Ctrl+W. Также есть обратная команда для вставки выражения inline — Ctrl+Alt+N.
Ctrl+Shift+Delete
Вынести внутренние statements из внешнего блока (if, for, try). Обратите внимание на то, что происходит с except или else блоками. Также есть обратная команда для «обертывания» кода в блок — Ctrl+Alt+T.
Alt+Enter
При наведенном на регулярное выражение курсоре, вызывается контекстное меню, в котором есть опция проверки выражения на различные входные данные. Относительно недавно узнал об этой возможности — милая штука.
В дополнение хочу посоветовать замечательный инстумент Productivity Guide, который подсчитывает сколько раз вы использовали ту или иную фичу (неиспользуемые там также перечислены). Располагается это в Help->Productivity Guide.
На этом все. Оставляйте в комментариях горячие клавиши, которыми пользуетесь вы. Продуктивного кодинга!