Работа с кодом в Visual Studio Make code work in Visual Studio

Visual Studio включает эффективный интегрированный набор средств сборки и отладки проектов. Visual Studio provides a powerful integrated set of project build and debugging tools. Из этой статьи вы узнаете, как Visual Studio может помочь обнаружить проблемы в коде с помощью построения выходных данных, анализа кода, средств отладки и модульных тестов. In this article, find out how Visual Studio can help you find problems in your code using build output, code analysis, debugging tools, and unit tests.

Мы разобрались, как работать с редактором, и написали код. You’ve figured out the editor and created some code. Теперь необходимо убедиться, что код работает должным образом. Now, you want to make sure the code works properly. Отладка в Visual Studio, как и в большинстве интегрированных сред разработки (IDE), осуществляется в два этапа: построение кода для обнаружения и устранения ошибок проекта и компилятора и выполнение кода для обнаружения ошибок времени выполнения и динамических ошибок. In Visual Studio, as with most IDEs, there are two phases to making code work: building the code to catch and resolve project and compiler errors, and running the code to find run-time and dynamic errors.

Сборка кода Build your code

Существует два основных типа конфигурации сборки: отладка и выпуск. There are two basic types of build configuration: Debug and Release. При использовании конфигурации отладка создается более крупный и медленный исполняемый файл, обеспечивающий более широкие интерактивные возможности отладки во время выполнения. The Debug configuration produces a slower, larger executable that allows for a richer interactive run-time debugging experience. Исполняемый файл конфигурации отладка никогда не следует отправлять. The Debug executable should never be shipped. Конфигурация выпуск позволяет создать более быстрый оптимизированный исполняемый файл, подходящий для отправки (по крайней мере с точки зрения компилятора). The Release configuration builds a faster, optimized executable that’s appropriate to ship (at least from the perspective of the compiler). По умолчанию используется конфигурация Отладка. The default build configuration is Debug.

Самый простой способ выполнить сборку проекта — нажать клавишу F7, однако вы также можете начать сборку, выбрав в главном меню пункты Сборка > Собрать решение. The easiest way to build your project is to press F7, but you can also start the build by selecting Build > Build Solution from the main menu.

Процесс сборки можно наблюдать в окне Вывод в нижней части пользовательского интерфейса Visual Studio. You can observe the build process in the Output window at the bottom of the Visual Studio UI. Здесь отображаются ошибки, предупреждения и операции сборки. Errors, warnings, and build operations are displayed here. При наличии ошибок (или предупреждений выше заданного уровня) сборка завершится ошибкой. If you have errors (or if you have warnings above a configured level), your build fails. Можно щелкнуть ошибку и предупреждение, чтобы перейти к строке, где они возникли. You can click on the errors and warnings to go to the line where they occurred. Для перестроения проекта можно нажать клавишу F7 (чтобы перекомпилировать только файлы с ошибками) или CTRL+ALT+F7 (для чистого полного перестроения). Rebuild your project by either pressing F7 again (to recompile only the files with errors) or Ctrl+Alt+F7 (for a clean and complete rebuild).

В окне результатов содержатся два окна с вкладками под областью редактора: окно Вывод, в котором содержатся необработанные выходные данные компилятора (включая сообщения об ошибках), и окно Список ошибок, содержащее список всех ошибок и предупреждений, к которому можно применить сортировку и фильтры. There are two tabbed windows in the results window below the editor: the Output window, which contains the raw compiler output (including error messages); and the Error List window, which provides a sortable and filterable list of all errors and warnings.

После успешного выполнения построения вы увидите примерно следующие результаты в окне Вывод: When build succeeds, you see results like this in the Output window:

Просмотр списка ошибок Review the Error List

Если вы внесли какие-либо изменения в код, который был ранее и успешно скомпилирован, возможно, возникнет ошибка. Unless you’ve made no modifications to code you’ve previously and successfully compiled, you probably have an error. Если вы новичок в написании кода, возможно, их будет много. If you’re new to coding, you probably have lots of them. Ошибки иногда очевидны, например простая синтаксическая ошибка или неправильное имя переменной, а иногда их причину трудно выяснить, имея в распоряжении только зашифрованный код. Errors are sometimes obvious, such as a simple syntax error or incorrect variable name, and sometimes they are difficult to understand, with only a cryptic code to guide you. Чтобы получить более четкое представление о проблеме, перейдите вниз окна Вывод сборки и щелкните вкладку Список ошибок. При этом вы перейдете к более организованному представлению ошибок и предупреждений для проекта и получите доступ к некоторым дополнительным параметрам. For a cleaner view of the issues, navigate to the bottom of the build Output window, and click the Error List tab. This takes you to a more organized view of the errors and warnings for your project, and gives you some extra options as well.

Щелкните строку ошибки в окне Список ошибок, чтобы перейти в строку кода, в которой возникла ошибка. Click on the error line in the Error List window to jump to the line the error occurs in. (Кроме того, номера строк можно включить, нажав клавиши Ctrl+Q, введя номера строк, а затем выбрав Включить или отключить отображение номеров строк в результатах. (Or turn on line numbers by pressing Ctrl+Q, typing line numbers, and then choosing Turn line numbers on or off from the results. Это самый быстрый способ перехода в диалоговое окно Параметры, где можно включить номера строк. This is the fastest way to get to the Options dialog where you can turn on line numbers.)

Нажмите клавиши CTRL+G для быстрого перехода к номеру строки, в которой возникла ошибка. Press Ctrl+G to quickly jump to the line number where the error occurred.

Ошибку можно узнать по подчеркиванию красной волнистой линией The error is identified by a red «squiggle» underscore. Чтобы получить дополнительные сведения, наведите на нее указатель мыши. Hover over it for additional details. Внесите исправления, и подчеркивание исчезнет, хотя в результате исправления может возникнуть новая ошибка Make the fix and it will go away, although you may introduce a new error with the correction. (это называется «регрессия»). (This is called a «regression».)

Пройдите список ошибок и устраните все ошибки в коде. Walk through the error list and address all the errors in your code.

Просмотр подробных сведений об ошибках Review errors in detail

Многие ошибки трудны для восприятия, будучи представленными в терминах компилятора. Many errors may make no sense to you, phrased as they are in the terms of the compiler. В этом случае могут потребоваться дополнительные сведения. In those cases, you’ll need additional information. Из окна Список ошибок можно выполнить автоматический поиск в поисковой системе Bing для получения дополнительных сведений об ошибке или предупреждении. From the Error List window, you can do an automatic Bing search for more information on the error or warning. Щелкните правой кнопкой мыши по соответствующей строке записи и выберите Показать справочные сведения об ошибке из контекстного меню или щелкните гиперссылку с кодом ошибки в столбце код в списке ошибок. Right-click on the corresponding entry line and select Show Error Help from the context menu, or click on the hyperlinked error code value in the Code column of the Error List.

В зависимости от настроек результаты поиска по коду и описанию ошибки откроются в веб-браузере либо во вкладке Visual Studio с результатами поиска Bing. Depending on your settings, either your web browser displays the search results for the error code and text, or a tab opens inside Visual Studio and shows the results of the Bing search. Представленные результаты — из различных источников в Интернете, и, возможно, не все они будут полезными. The results are from many different sources on the Internet, and not all may be helpful.

Анализ кода Use code analysis

Средства анализа выполняют поиск общих проблем в коде, которые могут привести к ошибкам времени выполнения или проблемам управления кодом. Code analyzers look for common code problems that can lead to run-time errors or problems in code management.

Анализ кода C# и Visual Basic C# and Visual Basic code analysis

Visual Studio содержит встроенный набор анализаторов платформы компиляторов .NET, которые проверяют код на C# и Visual Basic при его наборе. Visual Studio includes a built-in set of .NET Compiler Platform analyzers that examine C# and Visual Basic code as you type. Можно установить дополнительные анализаторы в виде расширений Visual Studio или в виде пакетов NuGet. You can install additional analyzers as a Visual Studio extension, or as a NuGet package. При обнаружении нарушений правил они помечаются как в списке ошибок, так и в редакторе кода (волнистая линия под соответствующим кодом). If rule violations are found, they are reported both in the Error List and in the code editor as a squiggle under the offending code.

Анализ кода C++ C++ code analysis

Чтобы выполнить анализ кода C++, запустите статический анализ кода. To analyze C++ code, run static code analysis. Запустить этот компонент после устранения всех очевидных ошибок, препятствующих успешной сборке, и потратить некоторое время, чтобы устранить создаваемые им предупреждения, — очень полезная привычка. Get in the habit of running it once you’ve cleaned up the obvious errors that prevent a successful build, and take some time to address the warnings it may produce. Вы сможете избавиться от определенных будущих проблем, а также научитесь некоторым полезным приемам написания кода. You’ll save yourself some headaches down the road, and you may learn a few code style techniques.

Нажмите клавиши ALT+F11 (или выберите в верхнем меню команду Анализ > Выполнить анализ кода в решении) для запуска статического анализа кода. Press Alt+F11 (or select Analyze > Run Code Analysis on Solution from the top menu) to start static code analysis.

Все новые или обновленные предупреждения отображаются на вкладке Список ошибок в нижней части интегрированной среды разработки. Any new or updated warnings appear in the Error List tab at the bottom of the IDE. Щелкните предупреждение для перехода к нему в коде. Click on the warnings to jump to them in code.

Использование быстрых действий для исправления или рефакторинга кода Use Quick Actions to fix or refactor code

Быстрые действия, доступные с помощью значка лампочки или отвертки, позволяют выполнить встроенный рефакторинг кода. Quick Actions, available from the light bulb or screwdriver icon, let you refactor code inline. Это простой способ быстрого и эффективного устранения распространенных предупреждений в коде C#, C++ и Visual Basic. They are an easy way to fix common warnings quickly and effectively in C#, C++, and Visual Basic code. Для доступа к ним щелкните правой кнопкой мыши волнистую линию предупреждения и выберите Быстрые действия и рефакторинг. To access them, right-click on a warning squiggle and select Quick Actions and refactorings. Либо, когда курсор находится на строке с цветной волнистой линией, нажмите клавиши CTRL+ . Or, when your cursor is on the line with the colored squiggle, press Ctrl+. или выберите значок отвертки, лампочки или лампочки с ошибкой на поле. or select the light bulb, error light bulb, or screwdriver icon in the margin. Вы увидите список возможных исправлений или операций рефакторинга, которые можно применить к соответствующей строке кода. You’ll see a list of possible fixes or refactorings you can apply to that line of code.

Быстрые действия можно использовать в любом случае, когда средство анализа кода определяет возможность исправления, рефакторинга или улучшения кода. Quick Actions can be used wherever code analyzers determine there’s an opportunity to fix, refactor, or improve your code. Щелкните любую строку кода, откройте контекстное меню и выберите пункт Быстрые действия и рефакторинг. Click on any line of code, right-click to open the context menu, and select Quick Actions and refactorings. Если доступны варианты рефакторинга или улучшения, то они будут отображены. If refactoring or improvement options are available, they are displayed. В противном случае в левом нижнем углу интегрированной среды разработки появится сообщение Быстрые действия недоступны. Otherwise, the message No quick actions available here displays in the lower-left corner of the IDE.

Если вы привыкли работать с клавиатурой, вы можете использовать клавиши со стрелками и сочетание клавиш CTRL+ . With experience, you can quickly use the arrow keys and Ctrl+. для проверки возможностей оптимизации и очистки кода! to check for easy refactoring opportunities and clean up your code!

Запуск очистки кода Run Code Cleanup

В Visual Studio можно по запросу форматировать файл кода C#, в том числе параметры стиля кода, с помощью кнопки Очистка кода в нижней части редактора. Visual Studio provides on-demand formatting of your C# code file, including code style preferences, through the Code Cleanup button at the bottom of the editor.

Помимо форматирования пробелов, отступов и т. п., функция Очистка кода применяет определенные вами соглашения о стиле кода. In addition to formatting your file for spaces, indents, et cetera, Code Cleanup also applies a set of code style conventions that you define. Ваши настройки для каждого стиля кода считываются из файла EditorConfig, если такой существует в проекте, или из раздела Параметры стиля кода, который доступен через диалоговое окно Параметры. Your preferences for each code style are read from the EditorConfig file, if you have one for the project, or from the code style settings in the Options dialog box.

Отладка выполняемого кода Debug your running code

Успешно завершив сборку кода и его очистку, запустите код, нажав клавишу F5 или выбрав команду Отладка > Начать отладку. Now that you’ve successfully built your code and performed a little clean up, run it by pressing F5 or selecting Debug > Start Debugging. Приложение будет запущено в среде отладки, и вы сможете пронаблюдать его поведение. This starts your app in a debug environment so you can observe its behavior in detail. Интегрированная среда разработки Visual Studio изменяется во время выполнения приложения: окно Вывод заменяется двумя новыми окнами (в конфигурации окон по умолчанию): окном с вкладками Видимые/Локальные/Контрольные значения и окном с вкладками Стек вызовов/Точки останова/Параметры исключений/Вывод. The Visual Studio IDE changes while your app is running: the Output window is replaced by two new ones (in the default window configuration), the Autos/Locals/Watch tabbed window and the Call Stack/Breakpoints/Exception Settings/Output tabbed window. Эти окна имеют несколько вкладок, которые позволяют просмотреть и проверить переменные, потоки, стеки вызовов приложения и другие характеристики поведения во время выполнения приложения. These windows have multiple tabs that allow you to inspect and evaluate your app’s variables, threads, call stacks, and various other behaviors as it runs.

Остановите приложение, нажав клавиши SHIFT+F5 или кнопку Остановить. Stop your app by pressing Shift+F5 or by clicking the Stop button. Кроме того, можно просто закрыть главное окно приложения (или диалоговое окно командной строки). Or, you can just close the app’s main window (or command-line dialog).

Если код выполняется полностью и точно так, как ожидалось, вас можно поздравить. If your code ran perfectly and exactly as expected, congratulations! Но если он перестает отвечать, вызывает сбой или выдает какие-то странные результаты, потребуется найти источник проблем и исправить ошибки. However, if it stops responding, or crashed, or gave you some strange results, you’ll need to find the source of those problems and fix the bugs.

Задание простых точек останова Set simple breakpoints

Точки останова — это один из самых простых и важных компонентов надежной отладки. Breakpoints are the most basic and essential feature of reliable debugging. Точка останова указывает, где Visual Studio следует приостановить выполнение кода, чтобы вы могли проверить значения переменных или поведение памяти либо выполнение ветви кода. A breakpoint indicates where Visual Studio should suspend your running code so you can take a look at the values of variables, or the behavior of memory, or whether or not a branch of code is getting run. После установки или удаления точек останова перестраивать проект не нужно. You don’t need to rebuild a project after setting and removing breakpoints.

Установите точку останова, щелкнув дальнее поле строки, в которой требуется приостановить выполнение, или нажмите клавишу F9, чтобы установить точку останова в текущей строке кода. Set a breakpoint by clicking in the far margin of the line where you want the break to occur, or press F9 to set a breakpoint on the current line of code. Выполнение кода прерывается (останавливается) перед инструкциями для этой строки кода. When you run your code, it will pause (or break) before the instructions for this line of code are executed.

Чаще всего точки останова используются для решения следующих задач. Common uses for breakpoints include:

Чтобы точнее определить источник аварийного завершения или отсутствия отклика программы, расставьте точки останова вокруг и непосредственно в коде вызова метода, который, по вашему мнению, приводит к сбою. To narrow down the source of a crash or unresponsive program, scatter breakpoints throughout and around the code of the method call you think is causing the failure. При выполнении кода в отладчике удаляйте, а затем снова устанавливайте точки останова ближе друг к другу, пока не найдете строку кода, вызывающую ошибку. As you run code in the debugger, remove and then reset the breakpoints closer together until you find the offending line of code. Выполнение кода в отладчике описывается в следующем разделе. See the next section to learn how to run code in the debugger.

При добавлении нового кода установите точку останова в его начале и выполните код, чтобы убедиться в том, что он работает правильно. When you introduce new code, set a breakpoint at the beginning of it, and run the code to make sure it is behaving as expected.

При реализации сложного поведения задайте точки останова для алгоритмического кода, чтобы можно было проверить значения переменных и данные при прерывании программы. If you’ve implemented a complicated behavior, set breakpoints for the algorithmic code so you can inspect the values of the variables and data when the program breaks.

При написании кода C или C++ используйте точки останова для остановки кода, чтобы можно было проверить значения адреса (ищите значение NULL) и просмотреть значения счетчиков при отладке ошибок, связанных с памятью. If you’re writing C or C++ code, use breakpoints to stop the code so you can inspect address values (look for NULL) and reference counts when debugging for memory-related failures.

Дополнительные сведения о точках останова см. в статье Использование точек останова. For more information about using breakpoints, read Using breakpoints.

Проверка кода во время выполнения Inspect your code at run-time

Когда выполнение кода приостанавливается из-за достижения точки останова, строка кода, помеченная желтым цветом (текущий оператор), еще не выполнена. When your running code hits a breakpoint and pauses, the line of code marked in yellow (the current statement) has not executed yet. Вы можете выполнить текущий оператор и проверить, как изменились значения. At this point, you may want to execute the current statement and then inspect the changed values. Для выполнения кода в отладчике можно использовать ряд команд пошагового выполнения. You can use several step commands to execute code in the debugger. Если отмеченный код является вызовом метода, вы можете выполнить шаг с заходом, нажав клавишу F11. If the marked code is a method call, you can step into it by pressing F11. Кроме того, можно выполнить шаг с обходом строки кода, нажав клавишу F10. You can also step over the line of code by pressing F10. Дополнительные команды и подробные сведения о пошаговом выполнении кода см. в статье Навигация по коду с помощью отладчика. For additional commands and details on how to step through code, read Navigate code with the debugger.

Код, представленный на предыдущей иллюстрации, может выполняться отладчиком по одному оператору. Для этого можно нажимать клавишу F10 или F11 (так как здесь нет вызова метода, результат выполнения обеих команд будет одинаковым). In the preceding illustration, you can advance the debugger one statement by pressing either F10 or F11 (since there is no method call here, both commands have the same result).

Когда отладчик приостанавливает выполнение, можно проверить переменные и стеки вызовов, чтобы разобраться в происходящем. While the debugger is paused, you can inspect your variables and call stacks to determine what is going on. Находятся ли значения в тех диапазонах, которые вы ожидали увидеть? Are the values in the ranges you expect to see? Выполняются ли вызовы в правильном порядке? Are calls being made in the right order?

Наведите курсор на переменную для просмотра ее текущего значения и ссылок. Hover over a variable to see its current value and references. Если отображается значение, которое вы не ожидали увидеть, возможно, в предыдущем или вызывающем коде имеется ошибка. If you see a value you didn’t expect, you probably have a bug in the preceding or calling code. Более подробные сведения об отладке см. в статье об использовании отладчика. For more in-depth debugging information, learn more about using the debugger.

Кроме того, Visual Studio выводит на экран окно средств диагностики, где можно наблюдать за загрузкой ЦП и использованием памяти приложением в динамике по времени. Additionally, Visual Studio displays the Diagnostic Tools window, where you can observe your app’s CPU and memory usage over time. В дальнейшем в процессе разработки приложения эти средства можно применять для выявления случаев непредвиденно высокой загрузки ЦП или чрезмерного выделения памяти. Later in your app development, you can use these tools to look for unanticipated heavy CPU usage or memory allocation. Это окно можно использовать в сочетании с окном Контрольные значения и точками останова, чтобы определить причину непредвиденно интенсивного использования или неосвобожденных ресурсов. Use it in conjunction with the Watch window and breakpoints to determine what’s causing unexpected heavy usage or unreleased resources. Дополнительные сведения см. в статье Обзор возможностей профилирования. For more information, see Profiling feature tour.

Запуск модульных тестов Run unit tests

Модульные тесты — это первая линия защиты от ошибок в коде, так как при правильном проведении они позволяют проверять отдельные «модули» кода (как правило, это отдельные функции), которые проще отлаживать, чем всю программу. Unit tests are your first line of defense against code bugs because, when done correctly, they test a single «unit» of code, typically a single function, and are easier to debug than your full program. Visual Studio устанавливает платформу модульного тестирования Майкрософт для управляемого и машинного кода. Visual Studio installs the Microsoft unit testing frameworks for both managed and native code. Платформа модульного тестирования используется для создания модульных тестов, их запуска и передачи результатов таких тестов. Use a unit testing framework to create unit tests, run them, and report the results of these tests. Завершив внесение изменений, запустите модульные тесты повторно, чтобы убедиться, что код по-прежнему работает правильно. Rerun unit tests when you make changes, to test that your code is still working correctly. При использовании выпуска Visual Studio Enterprise можно настроить автоматический запуск тестов после каждой сборки. With Visual Studio Enterprise edition, you can run tests automatically after every build.

Чтобы приступить к работе с модульными тестами, ознакомьтесь со статьей Создание модульных тестов для кода с помощью IntelliTest. To get started, read Generate unit tests for your code with IntelliTest.

Дополнительные сведения о модульных тестах в Visual Studio, а также о том, как они могут помочь в создании более качественного кода, см. в статье Основные сведения о модульных тестах. To learn more about unit tests in Visual Studio and how they can help you create better quality code, read Unit test basics.