Как закомментировать несколько строк в python
Если следовать стилю кодирования, то PEP-8 рекомендует использовать # и для блочных комментариев . Это значит, что комментировать нужно каждую строку. Например:
# Первая строка комментария # Вторая строка комментария # и т.д. Но существует хак, а именно заключать строковые литералы в тройные апострофы:
''' Первая строка комментария Вторая строка комментария и т.д. ''' Горячие клавиши pycharm
Есть ли в pycharm функция множественного выделения как в sublime text(можно поставить много курсоров и одновременно в разных строках редактировать текст, в sublime Ctrl + клик мышкой). А также очень не хватает возможности быстро выделить одинаковое слово, в sublime — Ctrl + D . А также как вы решаете проблему одинаковых сочетаний горячих клавиш в линкусе и в самом пайчарме, например Ctrl + Alt + l в pycharm должен запустить reformat code но в линуксе это блокирует экран.
Отслеживать
22.4k 11 11 золотых знаков 58 58 серебряных знаков 121 121 бронзовый знак
Python комментарии
Как и многие другие высокоуровневые языки программирования, Python позволяет оставлять комментарии в исходном коде программы. Комментарии бывают двух видов: однострочные и многострочные, в зависимости от количества занимаемых строк. Для создания пояснений к различным модулям, классам, функциям и методам можно применять конструкции docstring.
Что такое комментарии и зачем они нужны?
Комментариями принято называть текстовые пояснения, которые улучшают понимание кода и находятся непосредственно в самой программе. Благодаря специальному синтаксису, они выделяются на фоне инструкций, предназначенных для выполнения компьютером. Это дает возможность компилятору и интерпретатору игнорировать подобные текстовые вставки, во время обработки исходного кода программы.
Поскольку комментарии никак не затрагивают результат выполнения других инструкций, их можно использовать для временного закрытия отдельных блоков кода. Это ускоряет поиск ошибок и облегчает тестирование программы.
Таким образом, комментарии представляют собой специальные текстовые строки, которые никоим образом не влияют на ход выполнения программы. При желании в них можно писать все что угодно, поскольку компилятор и интерпретатор не будут обращать на них внимание. Грамотное использование комментариев позволяет значительно улучшить понимание текста программы другими людьми во время работы над общим проектом. Кроме того, реализация подобных пояснений помогает их автору быстро разбираться в ранее написанном коде. Такая потребность часто возникает при необходимости улучшить или доработать программу.
Однострочные
В каждом отдельно взятом языке программирования используется собственный синтаксис однострочных комментариев. Зачастую в роли специального оператора, который сообщает компьютеру о том, что следующая строка является комментарием, задействуется двойной слеш (//). В Python эту функцию выполняет обычный символ решетки (#). Следующий код демонстрирует создание двух однострочных комментариев внутри самой программы.
# this is a comment # print("Hello World!")
Если запустить программу с этим кодом на выполнение, ничего не произойдет, поскольку, как уже было сказано ранее, комментарии полностью игнорируются компьютером. Писать пояснения можно не только на английском, но и на русском языке. Для русских комментариев в Python нужно подключить кодировку UTF-8 (Unicode Transformation Format, 8-bit). В противном случае, компилятор выдаст ошибку, не сумев правильно распознать символы кириллицы.
# coding: utf-8 # это комментарий
Комментарий может находиться в любой части программы, закрывая от компилятора не только целую строку, но и ее отдельную часть, идущую за символом решетки. Пояснение, расположенное следом за определенной командой, как правило, должно в максимально лаконичной форме передавать ее смысл. В следующем примере комментарии отображают точки старта и завершения программы, а также передают назначение функции print().
# coding: utf-8 # начало программы print("Hello World!") # выводим приветствие на экран # конец программы
Создавая комментарии, необходимо принять во внимание тот факт, что символ решетки не задействуется по прямому назначению, если заключен в строковый литерал. В приведенном ниже фрагменте кода данный оператор является частью строки под названием string. Работая в IDE (Integrated Development Environment), можно увидеть, что комментарии автоматически выделяются курсивом и обладают особой подсветкой, облегчающей их распознавание.
string = "# это не комментарий"
После ввода символа решетки, весь дальнейший текст будет считаться комментарием, вне зависимости от того, какие ключевые слова или операторы используются за ним.
string = "text" ####### это комментарий #######
В приведенном выше фрагменте кода за инициализацией строк string следует однострочный комментарий. Таким образом, количество символов решетки может быть произвольным.
Многострочные
Большинство высокоуровневых языков программирования поддерживают многострочные комментарии, которые помогают более подробно описывать детали реализации сложных для понимания блоков кода. Общепринятым синтаксисом для данной конструкции является слеш со звездочкой в начале выделенного блока (/*) и те же самые символы в обратном порядке в конце комментария (*/). Однако Python не поддерживает подобную возможность, вместо нее предлагая использовать совокупность нескольких однострочных комментариев.
# coding: utf-8 # программа Hello World # создает и выводит строку на экран # начало программы greeting = "Hello World!" # создаем строку print(greeting) # выводим строку на экран # конец программы
Программа, приведенная выше, содержит набор однострочных комментариев, при помощи которых формируется в Python блок закомментированных пояснений к коду. Для тех, кто работает в простом редакторе кода или блокноте, такой подход покажется очень неудобным, так как при помощи символов решетки нельзя одновременно выделить и закомментировать несколько строчек программы, запретив тем самым их выполнение. Вместо этого приходится все комментировать по отдельности.
Однако современные IDE и редакторы кода, такие как PyCharm или NetBeans способны не только отображать синтаксис языка, но также поддерживают множество горячих клавиш для более быстрого написания программ. С их помощью можно моментально закомментировать огромный блок кода, а также оперативно избавиться от символов решетки в начале каждой строки. Это существенно ускоряет работу программиста и улучшает удобство тестирования.
Так, например, чтобы закомментировать несколько строк Python кода, в PyCharm, следует их выделить и нажать комбинацию клавиш +.
Docstring
Для создания документации к различным модулям, классам, функциям и методами в Python широко применяется такой инструмент как docstring. Согласно официальному соглашению PEP 8 (Python Enhancement Proposal), которое содержит в себе комплекс общепринятых норм по написанию кода, в Python docstring необходимо использовать в качестве поясняющей конструкции для всех создаваемых блоков кода. Такие примечания необходимо помещать сразу же после определения класса, метода, функции или модуля, заключая текст в тройные кавычки.
# coding: utf-8 # программа Hello World def greeting(): """Функция приветствия. Создает и выводит строку на экран. """ greeting = "Hello World!" # создаем строку print(greeting) # выводим строку на экран greeting() # вызываем функцию greeting() print(greeting.__doc__) # выводим docstring
Данный пример демонстрирует работу функции greeting(), которая создает строку и выдает ее на экран. Здесь применяется конструкция docstring, сообщающая программисту основные сведения о вызываемом методе. В отличие от обычных комментариев, docstring, как правило, обрабатывается компилятором и помещается в полученный байт-код. Во время выполнения программы записанные ранее сведения можно вывести на экран с помощью метода __doc__.
В спецификации PEP 8 определены базовые рекомендации использования docstring. Согласно общепринятым нормам в комментариях к функциям Python, первая строка документации должна представлять собой лаконичную сводку о назначении объекта, начинаясь с прописной буквы и заканчиваясь точкой. Вторая строка обязана быть пустой, в то время как последующие абзацы могут содержать более подробное описание внутренних особенностей объекта, его характеристики, особенности вызова и сторонние эффекты.
Применение docstring в качестве комментария
Несмотря на отсутствие прямой возможности создавать в коде Python 3 многострочные комментарии, язык Python позволяет использовать инструмент docstring для их замены. Сделать это можно при помощи тройных кавычек, просто поместив в них нужный текст. Таким образом, создается многострочный литерал, который не принадлежит какому-либо объекту, а поэтому не играет никакой роли во время обработки программного кода компилятором. Следующий пример демонстрирует применение docstring в качестве многострочного примечания в коде.
# coding: utf-8 """ программа Hello World создает и выводит строку на экран """ # начало программы greeting = "Hello World!" # создаем строку print(greeting) # выводим строку на экран # конец программы
Несмотря на простоту такого подхода, пользоваться им не рекомендуется, так как основным назначением docstring является документирование объектов.
Если тройные кавычки будут помещены сразу же после объявления метода или класса, компилятор воспримет их не как комментарий, а как описание docstring.
Именно по этой причине всегда лучше пользоваться символами решетки, комментируя большие объемы кода с помощью горячих клавиш IDE.
Заключение
Комментарии в языке программирования Python используются для создания собственных пояснений к исходному коду программы. Это позволяет улучшить его понимание другими людьми в процессе командной работы над большими проектами. В языке предусмотрены только однострочные комментарии, однако при помощи текстовых блоков можно получить аналог многострочных комментариев. Для создания документации к отдельным функциям, методам, классам и модулям применяются конструкции docstring. Общепринятые правила документирования исходного кода подробно описаны в сборнике рекомендаций PEP 8.
Горячие клавиши PyCharm
Unix
Автор admin На чтение 4 мин. Просмотров 179k. Опубликовано 12 октября, 2016
PyCharm — это мощный IDE и возможно лучший, для языка Python. А использование горячих клавиш сильно ускоряет и упрощает разработку.
Без лишних слов представляем небольшую подборку:
Работа с закладками:
| Поставить или снять закладку | F11 |
| Аналогично с присвоением буквы или цифры | Ctrl + F11 |
| Переход к закладке (удаление — клавишей Delete) | Shift + F11 |
| Быстрый переход к закладке с присвоенным числом | Ctrl + Число |
Редактирование:
| Отменить последнее действие | Ctrl + Z |
| Отменить последнюю отмену действия | Ctrl + Shift + Z |
| Расширенная вставка из буфера обмена (с историей) | Ctrl + Shift + V |
| Инкрементальное выделение выражения | Ctrl (+ Shift) + W |
| Перемещение между словами | Ctrl + влево/вправо |
| Прокрутка кода без изменения позиции курсора | Ctrl + вверх/вниз |
| Переход в начало/конец файла | Ctrl + Home/End |
| Удаление строки, отличие в том, где потом окажется курсор | Shift + Del (Ctrl + Y) |
| Удалить от текущей позиции до конца слова | Ctrl + Del |
| Удалить от текущей позиции до начала слова | Ctrl + Backspace |
| Дублировать текущую строку | Ctrl + D |
| Увеличить / уменьшить текущий отступ | Tab / Shift + Tab |
| Выравнивание отступов в коде | Ctrl + Alt + I |
| Приведение кода в соответствие Code-Style | Ctrl + Alt + L |
| Закомментировать/раскомментировать текущую строку | Ctrl + / |
| Закомментировать/раскомментировать выделенный код | Ctrl + Shift + / |
| Фолдинг, свернуть/развернуть | Ctrl + -/+ |
| Фолдинг, свернуть/развернуть все | Ctrl + Shift + -/+ |
| Сделать текущий скоуп сворачиваемым и свернуть его | Ctrl + Shift + . |
| Сделать текущий скоуп несворачиваемым | Ctrl + . |
| Замена в тексте | Ctrl + R |
| Замена во всех файлах | Ctrl + Shift + R |
Работа с окнами, вкладками:
| Перемещение между вкладками | Alt + влево/вправо |
| Закрыть вкладку | Ctrl + F4 |
| Открытие/закрытие окон Project, Structure, Changes и тд | Altl + число |
| Переключение между вкладками и окнами | Ctrl + Tab |
| Закрыть активное окно | Shift + Esс |
| Открыть последнее закрытое окно | F12 |
| Zoom, если он был вами настроен | Ctrl + колесико мыши |
Работа с поиском:
| Быстрый поиск по всему проекту | Дважды Shift |
| Быстрый поиск по настройкам, действиям и тд | Ctr + Shift + A |
| Перейти к следующему/предыдущему методу | Alt + вниз/вверх |
| Перемещение к началу и концу текущего скоупа | Ctrl + [ и Ctrl + ] |
| Поиск в файле | Ctrl + F |
| Поиск по всем файлам (переход — F4) | Ctr + Shift + F |
| Искать слово под курсором | Ctrl + F3 |
| Искать вперед/назад | F3 / Shift + F3 |
| Переход к строке или строке:номеру_символа | Ctrl + G |
| Список методов с переходом к их объявлению | Ctrl + F12 |
| Список недавно открытых файлов с переходом к ним | Ctrl + E |
| Список недавно измененных файлов с переходом к ним | Ctrl + Shift + E |
| Иерархия наследования текущего класса и переход по ней | Ctrl + H |
| Иерархия вызовов выбранного метода | Ctrl + Alt + H |
| Поиска класса по имени и переход к нему | Ctrl + N |
| Поиск файла по имени и переход к нему | Ctrl + Shift + N |
| Перейти к объявлению переменной, класса, метода | Ctrl + B |
| Перейти к реализации | Ctrl + Alt + B |
| Определить тип и перейти к его реализации | Ctrl + Shift + B |
| Перемещение назад по стеку поиска | Shift + Alt + влево |
| Перемещение вперед по стеку поиска | Shift + Alt + вправо |
| Переход к следующей / предыдущей ошибке | F2 / Shift + F2 |
| Найти все места, где используется метод / переменная | Shift + Alt + 7 |
| Как предыдущий пункт, только во всплывающем окне | Ctrl + Alt + 7 |
Генерация кода и рефакторинг:
| Полный автокомплит | Ctrl + Space |
| Автокомплит с фильтрацией по подходящему типу | Ctrl + Shift + Space |
| Простой автокомплит по словам, встречающимся в проекте | Alt + / |
| Реализовать интерфейс | Ctrl + I |
| Переопределить метод родительского класса | Ctrl + O |
| Генерация шаблонного кода (обход по итератору и тд) | Ctrl + J |
| Обернуть выделенный код в один из шаблонов | Ctrl + Alt + J |
| Генератор кода — сеттеров, зависимостей в pom.xml и тд | Alt + Insert |
| Переименование переменной, класса и тд во всем коде | Shift + F6 |
| Изменение сигнатуры метода во всем коде | Ctrl + F6 |
| Перемещение метода, класса или пакета | F6 |
| Создать копию класса, файла или каталога | F5 |
| Создать копию класса в том же пакете | Shift + F5 |
| Безопасное удаление класса, метода или атрибута | Alt + Delete |
| Выделение метода | Ctrl + Alt + M |
| Выделение переменной | Ctrl + Alt + V |
| Выделение атрибута | Ctrl + Alt + F |
| Выделение константы (public final static) | Ctrl + Alt + C |
| Выделение аргумента метода | Ctrl + Alt + P |
| Инлайнинг метода, переменной, аргумента или константы | Ctrl + Alt + N |
| Оптимизация импортов | Ctrl + Alt + O |
Тут представлены не все горячие клавиши, если этого для вашей работы не достаточно можете поискать нужные тут.