Как комментировать в vs code

Комментарии в коде (Visual Basic)

В примерах кодов часто встречается символ начала комментария ( ‘ ). Этот символ указывает компилятору Visual Basic игнорировать следующий текст или комментарий. Комментарии — это краткие заметки, внесенные в код, чтобы сделать чтение кода более легким.

Хорошим стилем программирования считается начинать все процедуры с краткого комментария, описывающего функциональные характеристики процедуры (то, что она делает). Это необходимо для вашего собственного удобства и удобства того, кто читает этот код. Следует отличать детали реализации (как процедура работает) от комментариев, описывающих функциональные характеристики. Если в комментарий включены детали реализации, их следует обновлять при редактировании кода.

Комментарии могут располагаться в конце той же строки, где содержится оператор, или занимать отдельную строку. Оба способа представлены в следующем коде:

' This is a comment beginning at the left edge of the screen. text1.Text = "Hi!" ' This is an inline comment.

Если комментарий занимает более одной строки, каждая строка должна начинаться с символа начала комментария, как показано в следующем примере.

' This comment is too long to fit on a single line, so we break ' it into two lines. Some comments might need three or more lines.

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

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

Тип комментария	Описание комментария
Назначение	Описание действий, совершаемых процедурой (но не того, каким образом совершаются эти действия)
Предположения	Список всех внешних переменных, элементов управления, открытых файлов, к которым осуществляется доступ из процедуры
Произведенный эффект	Список внешних переменных, элементов управления или файлов, на которые влияет данная процедура (если это влияние не очевидно)
Входные данные	Описание назначения аргументов
Возвращаемое значение	Описание значений, возвращаемых процедурой

Также рекомендуется принять во внимание следующие моменты.

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

Вы можете добавить или удалить символы комментариев для блока кода, выбрав одну или несколько строк кода и выбрав кнопки Комментарий () и Раскомментировать () на панели инструментов Изменить .

Кроме того, можно добавить в код комментарии, поставив в начале текста ключевое слово REM . ‘ Однако символ и кнопкиРаскомментировать / комментарии проще в использовании и требуют меньше места и памяти.

См. также раздел

Основные инстинкты— документирование кода с помощью xml-комментариев
Практическое руководство. Создание XML-документации
XML-теги для комментариев
Соглашения о структуре программы и коде
Оператор REM

Совместная работа с нами на GitHub

Источник этого содержимого можно найти на GitHub, где также можно создавать и просматривать проблемы и запросы на вытягивание. Дополнительные сведения см. в нашем руководстве для участников.

Комментарии в Visual Studio для Mac

Visual Studio для Mac планируется выйти на пенсию 31 августа 2024 года в соответствии с современной политикой жизненного цикла Майкрософт. Хотя вы можете продолжать работать с Visual Studio для Mac, есть несколько других вариантов для разработчиков на Mac, таких как предварительная версия нового расширения комплекта разработки C# для VS Code.

При отладке кода или экспериментировании с ним может потребоваться комментировать блоки кода как временно, так и в долгосрочной перспективе.

Чтобы оставить комментарий к целому блоку кода, сделайте следующее:

Выделите код и выберите пункт Закомментировать или раскомментировать строку в контекстном меню

Используйте настраиваемое сочетание клавиш cmd + / для выделенного кода.

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

В файлах C# можно добавить дополнительные уровни комментариев для строк, что позволяет закомментировать или раскомментировать области кода, сохранив фактические комментарии:

multi-level comments

Комментарии также удобно использовать при документировании кода для разработчиков, которые могут столкнуться с ним в будущем. Это выполняется в виде многострочных комментариев, которые в каждом языке добавляются следующим образом:

/* This is a multi-line comment in C# */

(* This is a multi-line comment in F# *)

См. также

Быстрое Комментирование в MSVS

Ctrl+M, затем Ctrl+O — схлопывает все хлопушки до обзорного состояния
Ctrl+M, затем Ctrl+L — расхлопывает все хлопушки по полной (при повторном нажатии полностью схлопывает до корня)
Ctrl+M, затем Ctrl+M — схлопывает/расхлопывает текущую хлопушку

Для C++ наличие хлопушек внутри функций включается/выключается в настройках: Tools > Options > Text Editor > C/C++ > Formatting > Enable Outlining.

#2
12:27, 24 сен 2013

> Выделяем область и жмем Ctrl+K, а затем Ctrl+C.
> Обратное раскомментирование — Ctrl-K, а затем Ctrl-U.
В Microsoft те еще кони придумывают горячие клавиши по умолчанию. Midway отдыхает.

> советую поизучать хоткеи
Вот уж действительно придется именно изучать.

> Ctrl+U, Ctrl+Shift+U — переводит выделенный текст в нижний/ВЕРХНИЙ регистр, тоже очень удобно.
Очень удобно, это когда одна комбинация меняет регистр циклически. Так же очень удобно, когда при отсутствии выделения изменяется слово под курсором.

#3
12:31, 24 сен 2013

Просто в студии столько разных функций, что простых комбинаций уже не осталось, пошли комбо Ctrl+X+Y и т.п. 🙂

#4
12:52, 24 сен 2013

Да даже те что есть ни черта не очевидны. Ctrl+U эксклюзивно для Lower case изначально лол. Что же тогда для Upper case? Неужели Ctrl+L? Нет, Ctrl+L удаляет строку. Подождите, но ведь всем известно, что строка удаляется по Ctrl+Y. В Студии это, барабанная дробь, Redo! CtrlShift+Z ведь совсем не очевидно для отмены Ctrl+Z. Так же как и циклическое комментирование / раскомментирование по Ctrl+/ и по CtrlShift+/ для блочных комментариев. Ctrl+K Ctrl+C Ctrl+K Ctrl+U ведь намного удобней чем Ctrl+/, согласитесь.

Kartonagnick
Постоялец

#5
12:54, 24 сен 2013

Kozinaka
> Просто в студии столько разных функций, что простых комбинаций уже не осталось,
> пошли комбо Ctrl+X+Y и т.п. 🙂

Там можно настроить что угодно на что угодно. Я например, комментарии настроил так же, как в QtCreator: ‘ctrl’+’/’ — ставит/снимает комментарий с выделенной области.
Потому что мне удобно, когда в разных ИДЕ горячие клавиши ведут себя одинаково.

#6
13:01, 24 сен 2013

Мне проще оказалось привыкнуть к дефолтовым: на чужих компах (у коллег и друзей) своих настроек не понапихаешь, а манипулировать кодом иногда приходится. Я вот, сдуру, привык раскладку менять по Ctrl-Shift (из-за того что с Alt часто срабатывает оконная менюха), а теперь все, кто на моём компе что-то сделать пытается, мучаются, приходится постоянно комментировать, подсказывать, что у меня не как у людей настройки. Баловство это.

#7
13:03, 24 сен 2013

entryway
Ты бы сначала матчасть изучил, а потом уже пытался выступать.

Kartonagnick
> ‘ctrl’+’/’ — ставит/снимает комментарий с выделенной области.
В студии сто лет как есть комментирование выделенной области простым нажатием /

#8
13:04, 24 сен 2013

Kozinaka
> Мне проще оказалось привыкнуть к дефолтовым: на чужих компах (у коллег и
> друзей) своих настроек не понапихаешь
В последних студиях настройки не в облаке сохраняются?

#9
13:13, 24 сен 2013

entryway
Чур меня, не видывал я таких диковин ещё. Это в VS2013?
А насколько оперативно можно своё любимое загрузить, а потом выгрузить?

#10
13:19, 24 сен 2013

Kozinaka
> Это в VS2013?
У меня 2005. Я сам краем уха слышал. Вот что пишет Google:

Visual Studio 2013 will also automatically synchronize settings across your devices utilizing the Connected IDE experience. Synchronized settings include categories such as keyboard shortcuts, Visual Studio appearance (theme, fonts, etc.) and more, all while keeping you in full control through the Synchronized Settings options.

#11
13:26, 24 сен 2013

А, понятно, это между своими машинами синхронизировать. В любом случае, чтобы сориентироваться на чужом компьютере стоит помнить хоткеи по умолчанию.

. но спасибо за совет, буду знать, что можно радикально кнопки перевернуть.

#12
14:12, 24 сен 2013

Двиганье и копирование блоков строк в $тудии появилось?
А копипаст кликом?

#13
14:22, 24 сен 2013

Двигать влево и вправо: Tab и Shift+Tab;
выделять прямоугольные блоки, включая нулевой ширины: Alt+Mouse; (помогает сразу в пачках строк параллельные правки делать);
копипаст на Ctrl+V, куда быстрее?

Kartonagnick
Постоялец

#14
14:26, 24 сен 2013

Chipmunk
> Двиганье и копирование блоков строк в $тудии появилось?

мышкой: зажимаем левый батон и выделяем область строк. Отпускаем кнопку, выделенная область остается помеченной как «выделенная». Далее кликаем по выделенной области правым батоном и не отпуская перетаскиваем область мышкой в любое место.

ТОП горячих клавиш VS Code для начинающего джуна

«Поговорим не про Vim», олдам, сеньорам и тру-си-разработчикам на проверку: пользуетесь ли вы такими сочетаниями VS Code? Если же вы только начинаете программировать, влетаете в айти на реактивном самолете курсов по Питону, или просто не знаете ничего про хоткеи VS Code, возможно вам точно пригодится парочка сочетаний 🙂

Все сочетания описаны для VS Code на Windows
↓ / ↑ / ← / → — стрелки вниз, вниз и т.д.
ЛКМ / ПКМ / СКМ — левая, правая, средняя кнопки мышки соответственно.

Shift + Tab — сместить табуляцию на один шаг влево. Если вы пишете на Python, то табуляция или четыре пробела — ваш неизменный спутник. Но мало кто знает, что достаточно поставить курсор в любое место строки, нажать Shift + Tab и вуаля, вся строка смещается влево на «один таб».
Ctrl + / — закомментировать или раскомментировать строку. VS Code сам разберется, какой язык программирования вы используете, и в начале строки установит или удалит необходимый символ для комментария. Место, где находится курсор на строке неважно.
Shift + Del — удалить строку целиком. Теперь не нужно выделять мышкой всю строку и потом нажимать Backspace. Не нужно выделять всю строку. Правда!
Alt + ↑ / ↓ — перемещение строки с курсором вверх или вниз. Просто попробуйте и ощутите, насколько это удобно. Знаете шутку «стоит всего один раз зимой надеть подштанники, и ты уже не можешь остановиться»? Так вот стоит только один раз переместить так строку, и вы уже не сможете по-другому!
Shift + Alt + ↓ / ↑ — дублирование строки с курсором вниз. В зависимости от ↓ или ↑ курсор останется на текущей или новой строке. Теперь можно обойтись без Ctrl + C, хотя нет, нельзя =)
F2 — переименовать переменную. Прошу заметить, что переименовываются все переменные с таким названием только внутри блока, не внутри всего открытого файла. Часто нужно переименовать переменную, которая уже используется в нескольких местах функции, и тут либо вручную расставлять курсор в нужное место, либо поставить курсор на переменную и нажать F2.
F12 или Alt + ЛКМ на переменной — перейти к переменной или родительскому классу. Часто рассказывают про PyCharm, будто только он умеет проваливаться в родительские классы, чтобы посмотреть, какие его атрибуты мы можем переопределять, наследуясь от него; но так умеет и VS Code.
Ctrl + D — выделяет слово, на котором находится курсор. Следующее нажатие на D (удерживая Ctrl) выделить следующее по порядку вниз идентичное значение. Вот пишете вы функцию, и вам нужно выделить ближайшие значения ‘name’. Легко! Выделить все вхождения слова можно вот так — Ctrl + F2. Радует то, что курсор оказывается в конце каждого выделенного значения и сразу можно редактировать!
Ctrl + L — выделяет всю строку. Целиком. Теперь копипастить еще проще, не правда ли? =)
Ctrl + Alt + → — разделить рабочую область и переместить актуальную вкладку вправо. Ctrl + Alt + ← возвращает вкладку назад. Вы не поверите, насколько удобно видеть, например, models.py и views.py рядом.

А теперь неочевидные, но потрясающие возможности. Меню → Файл → Настройки → Сочетания клавиш (Ctrl + K + Ctrl + S), в строке поиска вводим необходимый параметр и кликаем по результату мышкой, после нажимаем нужные клавиши для установки пользовательской настройки и наслаждаемся. Команды, которые точно стоит попробовать:

editor.action.jumpToBracket — переход к парной скобке, у меня установлено на Ctrl + Q. Сначала переход к ближайшей скобке, а следующее нажатие перемещает вас к парной скобке и так далее. Часто нам нужно оказаться либо в начале скобок, либо в конце. А кликать мышкой или стрелками не всегда удобно. Теперь достаточно одного нажатия и вы у нужной скобки.

editor.action.selectToBracket — выделить все внутри ближайших скобок и сами скобки, у меня это Ctrl + Shift + Q. Сколько кликов мышкой, сколько ошибок, выделяя внутри скобок мышкой или Shift + стрелки. А теперь можно просто одним нажатием выделить все точно и быстро.

Буду благодарен за любые интересные и полезные хоткеи, пишите в комментариях, что понравилось из моих, и что вы используете сами?

P. S. В комментариях рассказали про логичную, но неочевидную возможность IDE-шек и иже с ними: чтобы вырезать или скопировать строку, необязательно выделять ее целиком, можно просто переместить курсор на неё. ❤️