Find code changes and other history with CodeLens

Straipsnis
06/30/2023

With CodeLens, you can stay focused on your work while you find out what happened to your code–all without leaving the editor. You can find references to a piece of code, changes to your code, linked bugs, Azure DevOps work items, code reviews, and unit tests.

Note

CodeLens is available in the Community edition of Visual Studio; however, the source control indicators are not available in this edition.

CodeLens can show you both where and how the individual parts of your code are used in your solution.

Screenshot of the CodeLens indicators in the code editor.

To choose the indicators that you want to see, or to turn CodeLens off and on, go to Tools > Options > Text Editor > All Languages > CodeLens.

Find references to your code

You can find references in C# or Visual Basic code. Here's how.

In the code editor, select the references indicator or press Alt+2.

Note

If the indicator shows 0 references, you don't have any references from your C# or Visual Basic code. However, there might be references in other items such as .xaml and .aspx files.
To view the referencing code, mouse over the reference in the list.
To open the file that contains the reference, double-click the reference.

Code maps

To see relationships between the code and its references, create a code map. In the code map shortcut menu, select Show All References.

Find changes in your code

Inspect your code's history to find out what happened to your code. Or, review changes before they're merged into your code so you can better understand how changes in other branches might affect your code.

You need:

Visual Studio Enterprise or Visual Studio Professional
Git or Azure DevOps Server (formerly Team Foundation Server) or Team Foundation Version Control

For C# or Visual Basic code that's stored with Team Foundation Version Control (TFVC) or Git, you get CodeLens details at the class and method levels (code element-level indicators).

For file types other than .cs or .vb, you get CodeLens details for the entire file in one place (file-level indicators).

Code element-level indicators

Code element-level indicators let you see who changed your code and what changes they made. Code element-level indicators are available for C# and Visual Basic code.

You can also view change history when you use Team Foundation Version Control (TFVC) in Azure DevOps Services.

The default time period is the last 12 months.

To see a detailed history of all the changes, including those changes from more than a year ago, select Show all file changes, which opens a History window.

From the History window, you can view all your files that are in a Git repository. You can then select the code element-level changes indicator for more details.

File-level indicators

You can also view the file-level indicators for an entire file.

Note

File-level indicators are not available for C# and Visual Basic files.

To get more details about a change, right-click the item. Depending on whether you're using TFVC or Git, there are options to compare the versions of the file, view details and track the changeset, get the selected version of the file, and email the author of that change. Some of these details appear in Team Explorer if you have it enabled; otherwise, these details appear in Git Changes tab, and might also appear on the horizontal scrollbar at the bottom of the editor.

You can also see who changed your code over time, which can help you find patterns in your team's changes and assess their impact.

Starting in Visual Studio 2022 version 17.12 Preview 2, you can show or hide file-level indicators on the editor's horizontal scrollbar. To hide the indicators, open Tools > Options > Text Editor > Advanced, and then disable the Show file level CodeLens indicator option. This option affects visibility for file types that have the file-level CodeLens control in the bottom editor scrollbar such as XAML, HTML, and CSS, and does not affect files that contain inline CodeLens.

Find changes in your current branch

Your team might have multiple branches, for example a main branch and a child development branch, to reduce the risk of breaking stable code. You can find out how many people changed your code and how many changes were made in the main branch by pressing Alt+6.

Find when your code was branched

To find when your code was branched, navigate to your code in the child branch. Then, select the changes indicator (or press Alt+6).

Find incoming changes from other branches

You can view incoming changes. And, you don't need to leave your current branch to review a change.

Find when changes got merged

You can see when changes got merged, so you can determine which changes are included in your branch.

Compare an incoming change with your local version

To compare an incoming change with your local version, double-click the changeset or press Shift+F10.

Branch icons

The icon in the Branch column tells you how the branch is related to the branch you're working in.

Icon	The change came from:
	The current branch
	The parent branch
	A child branch
	A peer branch
	A branch further away than a parent, child, or peer
	A merge from the parent branch to a child branch
	A merge from a child branch to the parent branch
	A merge from an unrelated branch (baseless merge)

Linked work items

Find linked work items by selecting the work items indicator or by pressing Alt+8.

Linked code reviews

Find linked code reviews by selecting the reviews indicator. To use the keyboard, hold down the Alt key and then press Left arrow or Right arrow to navigate the indicator options.

Linked bugs

Find linked bugs by selecting the bugs indicator or by pressing Alt+7.

Contact the owner of an item

Find the author of an item by selecting the authors indicator or by pressing Alt+5.

You can also open the shortcut menu for an item to see the contact options. (If you have Teams installed, you have additional communication options available to you.)

Associated unit tests

You can discover unit tests that exist for your C# or Visual Basic code without opening Test Explorer.

Go to application code that has associated unit test code.
If you haven't already, build your application to load the CodeLens test indicators.
Review the tests for the code by pressing Alt+3.
If you see a warning icon , the tests haven't run yet, so run them.
To review a test's definition, double-click the test item in the CodeLens indicator window to open the code file in the editor.
To review the test's results, choose the test status indicator ( or ) or press Alt+1.
To see how many people changed this test, who changed this test, or how many changes were made to this test, find your code's history and linked items.

Keyboard shortcuts

To use the keyboard to select indicators, press and hold the Alt key to display the related number keys, then press the number that corresponds to the indicator you want to select.

Note

To select the reviews indicator, hold down Alt while using the left and right arrow keys to navigate.

Q & A

Q: How do I turn CodeLens off or on or choose which indicators to see?

A: You can turn indicators off or on, except for the references indicator. Go to Tools > Options > Text Editor > All Languages > CodeLens.

When the indicators are turned on, you can also open the CodeLens options from the indicators. And, you can turn CodeLens file-level indicators on and off by using the chevron icons at the bottom of the editor window.

Q: Where is CodeLens?

A: CodeLens appears in C# and Visual Basic code at the method, class, indexer, and property level. CodeLens appears at the file level for all other types of files.

Make sure CodeLens is turned on. Go to Tools > Options > Text Editor > All Languages > CodeLens.
Azure DevOps-related indicators appear only when work items are linked to the code and when you have permissions to open linked work items. Confirm that you have team member permissions.
Unit test indicators don't appear when application code doesn't have unit tests. Test status indicators appear automatically in test projects. If you know that your application code has unit tests, but the test indicators don't appear, try building the solution (Ctrl+Shift+B).

Tip

CodeLens is available in Visual Studio Community edition, however, the source control indicators are not available in this edition.

Q: Why don't I see the work item details for a commit?

A: This might happen because CodeLens can't find the work items in Azure Boards. Check that you're connected to the project that has those work items, and that you have permissions to see those work items. Work item details might also not show if the commit description has incorrect information about the work item IDs in Azure Boards.

Q: How do I change the font and color for CodeLens?

A: Go to Tools > Options > Environment > Fonts and Colors.

CodeLens - Change font and color settings

To use the keyboard:

Press Alt+T+O to open the Options dialog box.
Press Up Arrow or Down Arrow to go to the Environment node, then press Left Arrow to expand the node.
Press Down Arrow to go to Fonts and Colors.
Press Tab to go to the Show settings for list, and then press Down Arrow to select CodeLens.

Q: Can I move the CodeLens heads-up display?

A: Yes, choose Dock icon to dock CodeLens as a window.

Q: How do I refresh the indicators?

A: This depends on the indicator:

References: This indicator updates automatically when the code changes. If the References indicator is docked as a separate window, refresh the indicator by selecting Refresh.
Team: Refresh these indicators by selecting Refresh CodeLens Team Indicators from the right-click menu.
Test: Find unit tests for your code to refresh the Test indicator.

Q: What's "Local Version"?

A: The Local Version arrow points at the most recent changeset in your local version of a file. When the server has more recent changesets, they appear above or below the Local Version arrow, depending on the order used to sort the changesets.

Q: My CodeLens test indicators no longer appear in my file when I first open my solution. How can I load them?

A: Rebuild your project to get CodeLens test indicators to load in your file. To improve performance, Visual Studio no longer fetches source information for test indicators when code files are loaded. Test indicators are loaded after a build, or when you navigate to a test by double-clicking on it in Test Explorer.

CodeLens lets you stay focused on your work while you find out what happened to your code–without leaving the editor. You can find references to a piece of code, changes to your code, linked bugs, work items, code reviews, and unit tests.

Note

CodeLens is available in Visual Studio Community edition, however, the source control indicators are not available in this edition.

See where and how the individual parts of your code are used in your solution:

CodeLens indicators in the code editor

Contact your team about changes to your code without leaving the editor:

CodeLens - Contact your team

To choose the indicators that you want to see, or to turn CodeLens off and on, go to Tools > Options > Text Editor > All Languages > CodeLens.