Как закомментировать код

Это краткое руководство научит вас использовать комментарии в VSCode, включая многострочные комментарии.

Я не знаю ни одного языка программирования, который бы не поддерживал комментарии.

Комментарии к коду невероятно полезны. При создании сложной функциональности я иногда даже пишу всю функцию в псевдокоде, прежде чем писать код.

Другая полезная функция - быстрое отключение одной или нескольких строк кода. Это очень удобно при отладке программы.

Комментарии служат двум основным целям:

1. Добавить информацию, которая дает контекст вашему коду;
2. Быстрое отключение кода во время отладки;

Вы будете использовать их в основном для добавления информации о вашей программы, которая поможет вашему будущему и вашим коллегам понять, что происходит.

Процесс комментирования

Сначала установите курсор в том месте, где вы хотите добавить комментарий.

Затем воспользуйтесь ярлыком комментария 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), комментарии будут продолжать накапливаться.

Урок №3 по C#: Комментирование кода