How to Comment in VS Code — The VSCode Comment Shortcut
This quick guide will teach you the VSCode comment shortcut and everything else you need to know about commenting in VS Code, including multi-line comments.
I don’t know of a programming language that does not support comments.
Code-comments are incredibly useful. When building out complex functionality, sometimes I’ll even write out the whole function in pseudo-code comments before writing any code.
Comments make code more readable and understandable. This is especially useful if you work on a large team with lots of people. Every comment you write could save you and your colleagues some back and forth on slack.
The other great use-case of comments is quickly disabling one or multiple lines of code. This comes in handy when debugging your program.
Comments serve two main use-cases:
- Add information that gives context to your code
- Quickly disable code while debugging
Here’s how to do both in VS Code:
Create a Comment in VSCode, the easy way.
You’ll use this mainly to add information to the flow of your program that will help your future-self and your colleagues understand what’s going on.
First, place your cursor where you’d like to add the comment. Then, use the VS Code comment shortcut that corresponds to your platform below.
- On Windows, the shortcut is: CTRL + /
- On Mac, the shortcut is: Command + /
The VSCode comment shortcut Mac is very similar to the Windows version.
Comment-out code in VSCode
This is the other main usage of comments. Commenting-out code while debugging. This is probably the most useful shortcut in here. Here’s how to do it:
- Select the text or code that you want to comment out
- Execute the shortcut that corresponds to your platform. (editor.action.commentLine)
- Windows: Ctrl + /
- Mac: Command + /
You can also uncomment using the same command. Select the code that is currently commented-out and execute the shortcut. It should become un-commented again.
Once you do it a few times it will become muscle memory and boost your productivity. I use this command constantly and can’t imagine not having it.
Toggling block comments in VSCode
Some programming languages support block comments. These are comments which span multiple lines of code (a block). If you want to comment out multiple lines of code within the same comment, this is what you’re looking for.
To toggle a VSCode comment block, you can use editor.action.blockComment:
- Windows: Shift + Alt + A
- Mac: Shift + Option + A
There’s one other way to comment and un-comment, but it’s not as handy.
Comment out code (editor.action.addCommentLine):
- Windows: Ctrl + K + C
- Mac: Command + K + C
Un-comment code (editor.action.removeCommentLine):
- Windows: Ctrl + K + U
- Mac: Command + K + U
The main difference with these commands is that they each only have a single purpose. They do not toggle code like the slash shortcut. So, if you keep executing (CTRL + K + C), the comments will keep piling up, as shown in the screenshot below.
The same is true for un-commenting.
Like I said, I think these commands are a lot less handy, and I don’t think there’s ever a good reason to them over the slash one. unless of course you rebound the slash shortcut to do something else.
Changing the comment key binds in VS Code
If for some reason you want to change the default key binds for commenting and uncommenting in VS Code, you can follow these steps:
Комментарий на несколько строк Visual Studio Code
Смотря различные гайды на ютубе,я видел как люди комментируют несколько строк одним разом при помощи символа # ,подскажите,что за комбинация клавиш позволяет это сделать?
Ctrl+K , а затем Ctrl+C комментирует выделенные строки с помощью # . Ctrl+K , а затем Ctrl+U убирает комментарий со строк. Если у Вас Mac OS, используйте Cmd вместо Ctrl .
Дизайн сайта / логотип © 2023 Stack Exchange Inc; пользовательские материалы лицензированы в соответствии с CC BY-SA . rev 2023.9.5.43611
Нажимая «Принять все файлы cookie» вы соглашаетесь, что Stack Exchange может хранить файлы cookie на вашем устройстве и раскрывать информацию в соответствии с нашей Политикой в отношении файлов cookie.
Как закомментировать код
Работа в VS Code
Это краткое руководство научит вас использовать комментарии в VSCode, включая многострочные комментарии.
Я не знаю ни одного языка программирования, который бы не поддерживал комментарии.
Комментарии к коду невероятно полезны. При создании сложной функциональности я иногда даже пишу всю функцию в псевдокоде, прежде чем писать код.
Другая полезная функция — быстрое отключение одной или нескольких строк кода. Это очень удобно при отладке программы.
Комментарии служат двум основным целям:
- Добавить информацию, которая дает контекст вашему коду;
- Быстрое отключение кода во время отладки;
Вы будете использовать их в основном для добавления информации о вашей программы, которая поможет вашему будущему и вашим коллегам понять, что происходит.
Процесс комментирования
Сначала установите курсор в том месте, где вы хотите добавить комментарий.
Затем воспользуйтесь ярлыком комментария VS Code, который соответствует вашей платформе.
- В Windows это сочетание клавиш выглядит следующим образом: CTRL + /
- На Mac это сочетание клавиш: Command + /
Вы также можете расскомментировать код с помощью той же команды. Выберите код, который в данный момент закомментирован, и выполните команду быстрого доступа. Он снова станет незакомментированным.
Как только вы проделаете это несколько раз, это станет мышечной памятью и повысит вашу производительность. Я использую эту команду постоянно и не могу представить, что у меня ее нет.
Переключение блочных комментариев в VSCode
Некоторые языки программирования поддерживают блочные комментарии. Они охватывают несколько строк кода (блок). Если вы хотите закомментировать несколько строк кода — это то, что вам нужно.
Чтобы переключить блок комментариев VSCode, вы можете использовать editor.action.blockComment:
- Windows: Shift + Alt + A
- Mac: Shift + Option + A
Есть еще один способ комментирования и разкомментирования, но он не так удобен.
Закомментируйте код (editor.action.addCommentLine):
- Windows: Ctrl + K + C
- Mac: Command + K + CСнять комментарий с кода (editor.action.removeCommentLine):
- Windows: Ctrl + K + U
- Mac: Command + K + U
Главное отличие этих команд в том, что каждая из них имеет только одно назначение. Они не переключают код, как ярлык со слэшем. Поэтому, если вы будете продолжать выполнять (CTRL + K + C), комментарии будут продолжать накапливаться.
Горячие клавиши в VS Code
Горячие клавиши в VS Code — это экономия времени и отличный способ упростить себе жизнь при разработке кода. Как правило, понимание ценности этого инструмента приходит с опытом, однако мы рекомендуем привыкать к горячим сочетаниям с первых же дней изучения программирования.
Что такое горячие клавиши в VS Code
В любом софте горячие клавиши — это сочетание двух или более клавиш на клавиатуре, при нажатии которых запускаются определенные действия в программе или операционной системе. Например, известные многим комбинации «Ctrl + C» и «Ctrl + V» позволяют копировать и вставлять текстовые строки или изображения соответственно, не тратя при этом время на открытие контекстного меню.
Конечно, во время разработки или отладки кода можно обойтись и без горячих клавиш. Все опции так или иначе доступны из надстроек или контекстного меню, вызвать которое можно кликом ПКМ (правая кнопка мыши). Однако для ускорения рабочего процесса рекомендуется все-таки изучить популярные сочетания клавиш, а то и настроить свои собственные. Сейчас узнаем, как это сделать.
Как настроить горячие клавиши
Для просмотра готовых и настройки собственных хоткеев откройте VS Code и кликните на иконку с шестеренкой в нижней левой части интерфейса. В контекстном меню выберите пункт «Сочетания клавиш», если у вас русскоязычная версия софта, или же «Hotkeys», если интерфейс на английском.
Откроется окно со списком всех горячих клавиш с описанием каждой команды. В верхней части есть строка поиска — в ней можете указать конкретный пункт, который хотите настроить. Допустим, надо изменить сочетание клавиш для дублирования выделенного участка кода. Найдите этот пункт через поиск в списке, затем кликните на иконку «+» слева от названия, чтобы добавить свое сочетание.
Вновь откроется окно с просьбой указать комбинацию клавиш. Зажмите на клавиатуре сочетание, которое считаете нужным для этой команды, затем нажмите Enter. Настройки применяются сразу же. Таким образом можно изменить и уже настроенные комбинации, если в этом есть потребность.
Полезные горячие клавиши
Давайте рассмотрим наиболее часто используемые разработчиками комбинации клавиш для VS Code. Для удобства поделим их на категории в зависимости от того, какие команды они делают.
Важно: комбинации указаны для операционной системы Windows. Если Visual Studio Code у вас установлен на MacOS, вместо клавиши Ctrl в описанных сочетаниях используйте кнопку Command. Вместо клавиши Alt на ПК с системой MacOS используется кнопка Option. В остальном различий нет.
Клавиши для навигации по коду
Манипуляции с окном редактора с помощью мыши — это просто, но долго и не всегда удобно. Тем более, если приходится работать с большим кодом на несколько тысяч строк с множеством блоков и разношерстных переменных. Упростить работу помогут навигационные хоткеи, указанные далее.
Shift + Tab — смещение табуляции на один шаг влево. Важное сочетание для разработчиков на языке Python, так как клавиша Tab «отбивает» ровно четыре пробела, что нужно для оформления кода.
F12 либо Alt + левая кнопка мыши — быстрый переход к переменной либо к родительскому классу.
Ctrl + D — выделение слова, на котором установлен курсор. Если после выделения повторно нажать на клавишу D, не отпуская при этом Ctrl, под выделение попадет следующее идентичное значение, идущее по порядку вниз. Удобно, если нужно быстро выделить ближайшие значения переменной.
Ctrl + Shift + L — это альтернатива для сочетания Ctrl + D, которая позволяет выделить все вхождения уже выделенного слова или фразы.
Ctrl + L — выделение строки полностью. Отлично работает в сочетании с «Копировать» и «Вырезать».
Ctrl + G — переход к строке с заданным номером. Нажмите комбинацию двух клавиш, затем введите номер строки, которую хотите увидеть. Сочетание сильно экономит время во время отладки кода.
Ctrl + Shift + / — переход к парной скобке. Комбинация спасает в ситуациях, когда кода становится так много, что разработчик начинает путаться в обилии открывающих и закрывающих скобок.
F12 — переход к переменной. Нашли в коде переменную с неизвестным происхождением и хотите узнать, где она объявлена и что у нее с областью видимости? Установите курсор на нее, нажмите на F12, и VS Code по каждому нажатию будет показывать места, в которых объявлена переменная.
Alt + Shift + стрелка влево/стрелка вправо — сжатие либо расширение выделенного фрагмента соответственно. Если нажимаете клавиши быстрее, чем водите мышью по дисплею, это сочетание определенно поможет в рабочих задачах.
Ctrl + ]/[ — в первом случае комбинация увеличивает табуляцию для строки, на которой установлен курсор, а во втором, напротив, уменьшает ее.
Ctrl + Shift + [ — сворачивает блок, в пределах которого установлен курсор. Удобно, если нужно на время скрыть часть кода, чтобы она не отвлекала от работы. Чтобы раскрыть сжатые таким образом блок, достаточно нажать сочетание клавиш Ctrl + Shift + ].
Ctrl + Home — быстро перемещает курсор в начало редактора. Если нужно моментально попасть в конец окна редактора, нажмите Ctrl + End.
Клавиши для быстрого редактирования
Быстрое и удобное перемещение по коду — это хорошо, но все же недостаточно для продуктивной работы разработчика. Вот несколько хоткеев, которыми пользуются при редактировании проекта.
Ctrl + / — комментирование или раскомментирование строки. Интересно, что программа VS Code автоматически проставляет символ для комментария в зависимости от выбранного вами языка. При этом курсор перед нажатием комбинации может находиться в любом месте строки — это неважно.
Shift + Del — удаление строки полностью. Зачем тратить время на ручное выделение строки мышью, а затем еще и нажатие на Backspace? Поставьте курсор в удаляемую строку, и нажмите сочетание.
Alt + стрелка вверх/стрелка вниз — двигает строку, на которой установлен курсор, вверх либо вниз соответственно. Экономит уйму времени, так как не нужно сперва выделять строку, затем нажимать Ctrl + C для копирования, перемещать курсор и вставлять строчку на новое место. Попробуйте сами!
Shift + Alt + стрелка вверх/стрелка вниз — копирует строку, на которой установлен курсор, и двигает ее вниз. Если нажать комбинацию со стрелкой вверх, курсор автоматически переместится на одну строчку вверх. Хотите, чтобы он остался на месте? Тогда вам нужно сочетание со стрелкой вниз.
F2 — назначение переменной нового имени. Важно: при использовании такой комбинации новое название присваивается всем одинаково названным переменным только внутри блока. Сочетание экономит время, так как не нужно вручную выделять параметры и переименовывать по одному.
Shift + Alt + F — автоматическое форматирование документа. При нажатии комбинации VS Code в первую очередь предложит установить одно из доступных расширений для форматирования кода (если такого еще нет). При повторном нажатии программа приведет код к читабельному виду.
Ctrl + K Ctrl + F — форматирование выделенной области кода. Эти два сочетания нужно прожимать в случае, если хотите привести к читабельному виду не весь документ, а некоторую его часть.
Ctrl + K Ctrl + X — обрезание пробелов в конце строки. Незаменимый хоткей, который используется на этапе рефакторинга кода. Экономит время на ручном удалении лишних пробелов. Большой плюс и в том, что комбинация может срабатывать одновременно на нескольких выделенных строках.
Alt + Z — включение либо отключение автоматического переноса слов. Если вдруг пишите настолько длинные строки кода, что они не помещаются в ширину экрана, нажмите на эту комбинацию.
ALT + клик левой кнопкой мыши — размножение курсора. С зажатым Alt кликайте на все строки, где хотите установить дополнительный курсор. Это можно сделать иначе — выделить несколько строк с зажатой средней кнопкой мыши. Удобно, если нужно редактировать разные участки кода сразу.
Ctrl + K, Ctrl + [ — поочередное нажатие этих сочетаний позволяет свернуть все субрегионы кода. Соответственно, чтобы их после этого быстро развернуть в стандартный вид, нужно нажать те же комбинации, но с закрывающей скобкой ].
Клавиши для быстрого запуска кода
Код написан, и неужели здесь возможности горячих клавиш заканчиваются? Нет, их преимущество раскрывается в том числе на этапе отладки проекта и во время редактирования возможных ошибок. Вот какими комбинациями пользуются многие разработчики:
F5 — запуск процедуры отладки кода.
Ctrl + F5 — запустить код без предварительной отладки. Используйте эту опцию, если уверены в том, что с кодом полный порядок и нет необходимости в его проверке перед запуском.
Shift + F5 — принудительно остановить процесс отладки.
Ctrl + Shift + F5 — перезапустить процесс отладки. Полезно, если в ходе проверки кода обнаружены ошибки, которые нужно исправить прежде, чем повторно запустить отладку.
Alt + F9 — переключить точку останова.
Ctrl + Shift + F9 — удалить все действующие точки останова.
Ctrl + Alt + Q — выполнить быструю проверку во время отладки.
Ctrl + F10 — выполнить код до активной позиции. Перед нажатием комбинации клавиш установите курсор на строку, на которой должно заканчиваться выполнение кода или его отладка. Удобно для поэтапной работы.
F8 — переход между ошибками во время отладки. Хоть это и не сочетание клавиш, все-таки очень полезный инструмент. Не нужно листать код колесиком мышки и искать подсвеченные строчки. Чтобы перейти на предыдущую ошибку, используйте комбинацию Shift + F8.
Клавиши для работы с терминалом
Работу с терминалом VS Code тоже можно и даже нужно оптимизировать, используя для этого горячие клавиши, предусмотренные разработчиками Visual Studio Code. Их не так много, поэтому на запоминание не потребуется много времени.
Ctrl + ` — вызов терминала. Повторное нажатие комбинации, соответственно, скрывает терминал.
Ctrl + Shift + ` — открыть новый терминал для работы.
Ctrl + Alt + стрелка вправо — разделение рабочего пространства с последующим перемещением активной вкладки в правую часть окна. Чтобы вернуть вкладку назад, нужно нажать аналогичную комбинацию, но со стрелкой влево.
Ctrl + R — переключение между средами разработки. При нажатии этой комбинации программа VS Code отобразит вам список всех рабочих пространств, используемых недавно. Важно: в случае, если вы перейдете в одно из недавних пространств, текущая сессия терминала закроется.
Shift + Page Up/Page Down — быстрая прокрутка окна терминала вверх или вниз соответственно.
Ctrl + \, E — просмотреть список со всеми ошибками, которые возникли при отладке/запуске кода.
Ctrl + Shift + M — отобразить панель с указанием найденных проблем.
Клавиши для работы с файловой системой
Многие разработчики, причем даже с большим опытом в программировании, до сих пор работают с файловой системой из контекстного меню «Файл». Однако это неудобно и отбирает много времени на поиск нужного подпункта. Это можно оптимизировать.
Ctrl + N — создать новый файл для работы с кодом.
Ctrl + Shift + N — открыть новое окно редактора Visual Studio Code.
Ctrl + W — закрыть окно редактора. Также можно воспользоваться сочетанием Ctrl + F4. Если нужно закрыть текущее окно редактора, нажмите комбинацию клавиш Ctrl + Shift + W.
Ctrl + K + O — открыть папку.
Ctrl + K + F — закрыть папку.
Ctrl + O — открыть файл.
Ctrl + W — закрыть файл.
Ctrl + S — сохранить изменения в файле.
Ctrl + Shift + S — сохранить изменения с указанием конкретного названия и расширения файла.
Ctrl + K + S — сохранить все открытые файлы.
Ctrl + K + P — скопировать путь, по которому располагается текущий файл.
Ctrl + Q — быстро открыть файл.
Клавиши для работы с Git
По умолчанию горячие клавиши для работы с Git в программе VS Code не назначены. Предлагаем настроить их самостоятельно, используя одну из популярных в среде разработчиков раскладку:
Alt + G + H — показать историю работы с системой управления версиями Git.
Alt + G + P — отправить изменения, внесенные в код.
Alt + G + C — зафиксировать изменения в памяти Git (закоммитить).
Alt + G + B — создать новую ветку.
Alt + G + T — переключиться с одной ветки на другую.
Alt + G + I — начать инициализацию Git.
Прочие горячие клавиши
Здесь мы перечислили еще несколько хоткеев, которые не вошли в предыдущие категории, но могут пригодиться при работе над проектом.
Ctrl + Z + K — активация дзен-режима. В таком режиме скрываются все лишние панели, а активное окно редактора открывается на весь экран. Ничего не отвлекает от разработки или отладки кода. Чтобы выйти из дзен-режима, достаточно нажать клавишу Esc.
F11 — отображение интерфейса в полноэкранном режиме. Если дзен-мод кажется вам интересным решением, но не хочется отказываться от важных для работы вкладок, используйте этот хоткей.
Ctrl + ` — переход к окну настроек. Даже если вы долго работаете в VS Code, наверняка приходится периодически открывать окно с параметрами, чтобы внести изменения или вспомнить, что значит та или иная комбинация клавиш. Вход в меню настроек можно упростить вот этим сочетанием.
Ctrl + Shift + Space — отображение подсказок по параметрам. Комбинация помогает новичкам и не только, когда не получается вспомнить порядок параметров, но читать документацию не хочется.
Ctrl + K Ctrl + T — открыть окно выбора темы оформления. Стандартный интерфейс VS Code может показаться слишком скучным даже любителям минимализма. Благо, есть возможность выбирать.
Alt + C/R/W — переключение чувствительности VS Code к регистру между одним из трех уровней.
Ctrl + B — включить либо отключить (при повторном нажатии) видимость боковой панели редактора.
Ctrl + Shift + F — открыть окно поиска по коду. Одно из главных сочетаний клавиш, которыми вы будете часто пользоваться как на этапе написания, так и в процессе редактирования кода.
Значимость горячих клавиш для разработки ПО
Исследователи из проекта Brainscape провели небольшой анализ и выяснили, что использование горячих клавиш в условиях стандартной 40-часовой рабочей недели экономит 8 рабочих дней в год! По их подсчетам, нажатие комбинации клавиш в среднем на 2 секунды быстрее, чем совершение той же команды, но из контекстного меню с помощью мыши. Если до сих пор не пользуетесь этим инструментом, в течение одного года вы совершенно бессмысленно теряете до 64 часов времени.
Серьезные IT-компании уделяют горячим клавишам особое внимание. Еще бы, ведь 8 рабочих дней можно не потратить впустую, а направить на работу над проектом, и добиться лучших результатов в сравнении с конкурентами. Но даже если вы начинающий разработчик или программист, который работает на фрилансе, внедрение хоткеев в рабочий процесс поможет развиться как специалист.
Ускорение разработки — не единственная причина внедрить горячие клавиши в рабочий процесс. Использование хоткеев банально удобнее, не нужно каждый раз наводиться мышью на требуемый пункт контекстного меню. Вместо этого автоматически срабатывает мышечная память. Для зрения тоже плюс, так как разработчику не приходится каждый раз искать глазами нужный пункт в меню.
Особо искушенные программисты могут пойти еще дальше, и использовать макросы при помощи специализированных программ или софта, управляющего клавиатурой/мышью. В этом случае есть возможность создавать целые связки горячих клавиш для особо часто выполняемых операций на этапе написания, рефакторинга или отладки кода. Это позволит сэкономить еще немного времени.
Начните использовать горячие клавиши в VS Code сейчас, и всего через несколько часов активного применения запомните большую часть сочетаний. На первое время можете выписать нужные вам хоткеи на лист бумаги или открыть памятку на втором мониторе, периодически поглядывая на нее. Если какие-то комбинации кажутся неудобными, помните, что их можно легко отредактировать.