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.7.43618
Нажимая «Принять все файлы cookie» вы соглашаетесь, что Stack Exchange может хранить файлы cookie на вашем устройстве и раскрывать информацию в соответствии с нашей Политикой в отношении файлов cookie.
sergey vasin
Еще несколько сочетаний клавиш в Visual Studio Code
Продолжим начатую в предыдущем посте тему и рассмотрим еще несколько полезных сочетаний клавиш в Visual Studio Code.
Folding
Что такое Folding? Это возможность свертывать части кода для того, чтобы он не загромождал имеющееся пространство редактора.
В разных средах разработки это реализовано по-разному. Тот вариант, что используется в Visual Studio Code — это так называемый language-unaware folding, то есть, он не зависит от используемого языка, и как следствие, не различает соответствующие языку конструкции, которые могли бы быть подходящими кандидатами на свертывание. В данном случае вся логика свертывания основана на отступах.
То есть, начало региона (части кода, которая подлежит свертыванию) соответствует строке с меньшим отступом относительно строк, следующих за ней. А конец региона находится непостредственно перед строкой, имеющей такой же (или меньший) отступ, что и первая строка региона.
Ctrl+Shift+[ — Fold, и Ctrl+Shift+[ — Unfold — сочетания клавиш, которые выполняют свертывание и развертывание регионов.
Таким образом, если мы нажмем сочетание клавиш Ctrl+Shift+[ в то время, когда
курсор будет находится внутри функции
эта часть кода будет выглядеть следующим образом
Вышеприведенные сочетания выполняют сверывание и развертывание частей кода в зависимости от текущего расположения курсора. Если же нам нужно свернуть или развернуть все существующие в редактируемом файле регионы, то мы можем воспользоваться сочетаниями клавиш Ctrl+K Ctrl+0 — Fold All — и Ctrl+K Ctrl+J — Unfold All.
Понятно, что регионы могут быть вложенными, и, таким образом их можно разделить на регионы первого уровня, второго и так далее. Для того, чтобы свернуть только регионы определенного уровня, существуют сочетания клавиш Ctrl+K Ctrl+1, Ctrl+K Ctrl+2 и так до Ctrl+K Ctrl+9.
Например, если мы нажмем сочетание Ctrl+K Ctrl+2, то код
станет выглядеть следующим образом
Еще один вид свертывания — это рекурсивное свертывание. В данном случае сначала свертываются регионы с наибольшим отступом, потом следующие за ними в порядке уменьшения отступа и так до регионов первого уровня. Происходит это все для той части кода, на которой в данный момент расположен курсор. Рекурсивное свертывание выполняется при нажатии клавиш Ctrl+K Ctrl+[ — Fold Recursively.
Для того, чтобы рекурсивно развернуть какую-либо часть кода используется сочетание клавиш Ctrl+K Ctrl+] — Unfold Recursively.
Indent
Теперь давайте поговорим об отступах.
Когда мы пишем код, для задания отступа удобнее всего пользоваться клавишей Tab. Когда код уже написан и нам нужно его подвинуть в ту или иную сторону, мы также можем использовать Tab для увеличения отступа и Shift+Tab для его уменьшения.
Если мы хотим поправить только одну строку, мы можем установить курсор в ее начало и воспользоваться вышеприведенными клавишами. Если это действие требуется для нескольких строк, перед использованием Tab или Shift+Tab нам потребуется их выделить, причем не обязательно полностью.
С другой стороны, мы можем увеличить или уменьшить отступ строки вне зависимости от того, в какой ее части находится курсор и выделена она или нет. В этом нам помогут сочетания клавиш Ctrl+[ — Outdent Line и Ctrl+] — Indent Line. Тем не менее, для изменения отступа нескольких строк одновременно, нам по-прежнему потребуется их выделить.
Comments
Несмотря на то, что мы можем определить строку (или несколько) как комментарий вручную, использование сочетаний клавиш позволяет сделать это немного быстрее и удобнее.
Для того, чтобы закомментировать (или раскомментировать) строку, мы можем использовать сочетание Ctrl+/ — Toggle Line Comment. Так же, как и в предыдущем случае, для того, чтобы закомментировать несколько строк одновременно, нам потребуется их выделить.
Для создания блочного комментария используется сочетание клавиш Shift+Alt+A — Toggle Block Comment.
Если мы нажмем эти клавиши без выделения чего-либо, результатом станет пустой блок комментария. С другой стороны, если перед тем, как нажать это сочетание, мы выделим какой-либо блок текста, результатом будет блочный комментарий, состоящий из выделенного текста.
Quotes, parentheses, etc.
Особенности, свойственные блочным комментариям, в части того, что при выделении текста и нажатии определенных клавиш этот текст становится обрамлен какими-либо символами, встречаются и в некоторых других случаях.
Например, также это свойственно таким символам, как одинарные кавычки, двойные кавычки, круглые скобки, квадратные скобки и фигурные скобки.
Select highlights
Еще одно полезное сочетание клавиш — Ctrl+Shift+L — Select All Occurrences of Find Match.
Полезно оно следующим. Когда вы используете поиск (Ctrl+F) для нахождения каких-либо элементов кода, то диалоговое окно поиска показывает вам найденные элементы по одному. В случае, когда вы хотите выделить сразу все найденные совпадения с целью их поправить или изменить, вам поможет вышеприведенное сочетание клавиш.
Кроме того, когда мы выделяем какой-либо элемент кода, можно заметить, что все остальные совпадения при этом также слегка подсвечиваются. Ctrl+Shift+L позволяет выделить все имеющиеся совпадения и в этом случае тоже.
Как закомментировать код
Работа в 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), комментарии будут продолжать накапливаться.