Finding Code Issues in Specific Scope
Design-time code inspection is a great help when you are coding in the editor or reviewing specific files. However, ReSharper also allows you to run static code analysis in the whole solution or narrower scope and examine the results in a friendly view. You can even share inspection results if necessary.
Starting code inspection
To inspect code in solution, project or in a custom scope
- Decide whether you want the results of the solution-wide inspections (e.g. unused public members) to be included in the report. If you want these results to be included, enable the solution wide-analysis. Note that when the solution-wide analysis is enabled, ReSharper has to analyze the whole solution even if you need to inspect a single project, so be prepared that it takes more time.
- Do one of the following:
- In the main menu, choose or .
- In the Solution Explorer, select items (files, folders, projects, solution folders) that you want to inspect, right-click the selection and choose Find Code Issues in the context menu.
- In the Architecture View, select one or more items, right-click the selection and choose Find Code Issues in the context menu.
- The Inspection Results window will open displaying detected code issues.
Analyzing inspection results
In the Inspection Results window, you can view the list of discovered code issues and locate them in the editor by double-clicking the entries:
Each new run of code inspection opens a new tab in the window so the results of previous runs are preserved until you close their tabs.
By default, issues are grouped by files. If necessary, you can regroup issues by type, severity, etc. using the Group by: selector.
To check context of the selected code issue, use the Preview pane that displays one or more lines related to the issue in the code file. Use the Show Preview selector to open the pane at the bottom or on the right of the window.
Filtering inspection results
When you inspect code, ReSharper apply code inspections with all severity levels. However, issues detected with inspections of 'Hint' severity are filtered out by default. If necessary, you can customize filtering of code issues.
Note that the selected filtering affects the way code issues are filtered in the current tab and the way issues are filtered the next time you run code inspection.
To filter issues in the inspection results
- If you want to hide issues of some type or hide all other issues except issues of this type, right-click a code issue and choose Hide All [Issue type] Issues or Show Only [Issue type] Issues correspondingly.
- For more precise filtering, click Filter Issues on the toolbar and use the Filter Issues dialog to specify issue types that should be displayed. The Defaults button in this dialog restores the default filtering when issues with severity levels of 'Hint' are filtered out.
Sharing inspection results
In large projects, code inspection results can be used im many different ways. For instance, to assign found issues to different developers: you can copy or export a code issue or a group of issues and submit the copy to an issue tracker.
To export inspection results to a file
- Open code inspection results in the Inspection Results window or enable the solution-wide analysis and open the list of errors in the Errors/Warnings in Solution window.
- Click Export on the toolbar to export the data currently displayed in the window in text format, or use the drop-down selector to export the data in XML or HTML format. The Export Data dialog that appears, will help you to save the data to a file or copy it to the clipboard.
- An alternative way to export current issues to an XML report, is to choose in the main menu and then specify file name and location.
Saving inspection results to the XML format has several advantages: first, this format is compatible with the output format of the InspectCode command-line tool and JetBrains TeamCity, second, you can later load and study it in th the Inspection Results window. Regardless of the tool that was used to generate the XML report, you can always open and examine it with ReSharper.
To study inspection results saved in an XML report
- In the main menu, choose .
- Select an XML report file and click Open.
- The report is opened in a new tab of the Inspection Results window. If the current solution corresponds to that of the XML report, you will be able to navigate to the issues by double-clicking on the inspection result items.
Besides exporting, you can copy individual entries or custom selections of entries shown in the Inspection Results window and Errors/Warnings in Solution window to the clipboard. The copied issue information include names of project and solution, file name and line number as well as the description of the issue. For example:
MyProject\About.aspx.cs:2 Using directive is not required by the code and can be safely removed