Visual studio как комментировать

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

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

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

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

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

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

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

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

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

C#

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

F#

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

См. также

Вставка XML-комментариев для создания документации

В этой статье описывается, как Visual Studio помогает документировать такие элементы кода, как классы и методы, автоматически создавая стандартную структуру комментариев xml-документации. Во время компиляции можно создать XML-файл, содержащий комментарии для документации.

Xml-файл, созданный компилятором, можно распространять вместе со сборкой .NET, чтобы Visual Studio и другие среды УДостоверений могли использовать IntelliSense для отображения быстрых сведений о типах и членах. Вы также можете запустить XML-файл с помощью таких средств, как DocFX и Sandcastle , чтобы создать справочные веб-сайты API.

Команда insert Comment для автоматической вставки структуры комментариев XML-документации доступна в C# и Visual Basic. Для C++можно вручную вставить комментарии xml-документации и по-прежнему создавать XML-файлы документации во время компиляции.

Включение создания документации

Чтобы включить создание документации, выберите файл, содержащий документацию по API, проверка box на вкладке «Вывод сборки>» свойств проекта.

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

Чтобы включить создание документации, выберите XML-файл документации проверка в разделе «Выходные данные сборки>» свойств проекта.

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

Кроме того, можно добавить свойства GenerateDocumentationFile или DocumentationFile в ФАЙЛ CSPROJ, VBPROJ или FSPROJ . Установите для GenerateDocumentationFile true создания файла документации с именем и расположением по умолчанию. DocumentationFile Используйте свойство, чтобы указать другое имя или расположение.

Если вы используете DocumentationFile самостоятельно или с GenerateDocumentationFile заданным true свойством, создается файл документации с указанным именем и расположением. Однако если задано GenerateDocumentationFile false значение, файл документации не создается, даже если задано DocumentationFile свойство.

Включение сочетания клавиш вставки комментариев

1. В строке меню Visual Studio выберите «Параметры инструментов>«.
2. В диалоговом окне «Параметры» перейдите к текстовому редактору >C# (или Visual Basic). >
3. В разделе «Примечания« выберите или отмените выбор примечаний к XML-документации для \\\ (или «».

Автоматическое вставка xml-комментария

1. В Visual Studio поместите курсор над элементом, который требуется документировать, например метод.
2. Выполните одно из следующих действий:
   • Если включена функция автоматического вставки комментариев, введите /// В C#или »’ Visual Basic.
   • В меню «Изменить» выберите IntelliSense>Insert Comment.
   • В контекстном меню щелкните правой кнопкой мыши или выберите фрагмент>вставить комментарий.

Структура комментариев XML немедленно создается над элементом кода. Например, при комментировании следующего GetUserName метода шаблон создает элемент, элемент параметра и элемент для документирования возвращаемого значения.

/// 
/// ///
 /// /// public string GetUserName(int id)

''' 
''' '''
 ''' ''' Public Function GetUserName(id As Integer) As String Return "username" End Function 

 /// 
/// Gets the username associated with the specified ID. ///
 /// The unique user ID. /// A string containing the username for the specified ID. public string GetUserName(int id)

При наведении указателя мыши на код можно использовать XML-элементы и стили в комментариях, которые отображаются в кратких сведениях. К этим элементам относятся курсив или полужирные стили, маркированные или нумерованные списки, а также доступные cref для щелчка или href ссылки.

Например, введите следующий код в файл программы C#:

/// 
/// There are two params. /// /// The user id /// The user name /// ///
 /// The username. public static string GetUserName(int id)

При наведении указателя мыши на GetUserName панель «Быстрая информация» отображается следующим образом:

Связанный контент

• Комментарии для документации
• XML-документация в Visual Basic
• Комментарии (C++)
• Документация XML (Visual C++)
• Создание кода

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

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

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

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

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

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

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

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

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

C#

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

F#

(* 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
> Двиганье и копирование блоков строк в $тудии появилось?

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