Walkthrough: Analyzing Managed Code for Code Defects

Article
11/15/2016

Note

This article applies to Visual Studio 2015. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

In this walkthrough, you analyze a managed project for code defects by using the code analysis tool.

This walkthrough will step you through the process of using code analysis to analyze your .NET managed code assemblies for conformance with the Microsoft .NET Framework Design Guidelines.

In this walkthrough, you:

Analyze and correct code defect warnings.

Prerequisites

Visual Studio Premium.

Create a class library

To create a class library

On the File menu of Visual Studio, click New and then click Project.
In the New Project dialog box, under Project Types, click Visual C#.
Under Templates, select Class Library.
In the Name text box, type CodeAnalysisManagedDemo and then click OK.
After the project is created, open the Class1.cs file.
Replace the existing text in Class1.cs with the following code:

//CodeAnalysisManagedDemo //Class1.cs using System; namespace testCode { public class demo : Exception { public static void Initialize(int size) { } protected static readonly int _item; public static int item { get { return _item; } } } }
Save the Class1.cs file.

Analyze the project

To analyze a managed project for code defects

Select the CodeAnalysisManagedDemo project in Solution Explorer.
On the Project menu, click Properties.

The CodeAnalysisManagedDemo properties page is displayed.
Click CodeAnalysis.
Make sure that Enable Code Analysis on Build (defines CODE_ANALYSIS constant) is checked.
From the Run this rule set drop-down list, select Microsoft All Rules.
On the File menu, click Save Selected Items, and then close the ManagedDemo properties pages.
On the Build menu, click Build ManagedDemo.

The CodeAnalysisManagedDemo project build warnings are reported in the Code Analysis and Output windows.

If the Code Analysis window does not appear, on the Analyze menu, choose Windows and then choose Code Analysis.

Correct the Code Analysis Issues

To correct code analysis rule violations

On the View menu, click Error List.

Depending on the developer profile that you chose, you might have to point to Other Windows on the View menu, and then click Error List.
In Solution Explorer, click Show All Files.
Next, expand the Properties node, and then open the AssemblyInfo.cs file.
Use the following to correct warnings:

CA1014: Mark assemblies with CLSCompliantAttribute: Microsoft.Design: 'demo' should be marked with the CLSCompliantAttribute, and its value should be true.
- Add the code using``System; to the AssemblyInfo.cs file.
  
  Next, add the code [assembly: CLSCompliant(true)] to the end of the AssemblyInfo.cs file.
  
  Rebuild the project.
CA1032: Implement standard exception constructors: Microsoft.Design: Add the following constructor to this class: public demo(String)
- Add the constructor public demo (String s) : base(s) { } to the class demo.
CA1032: Implement standard exception constructors: Microsoft.Design: Add the following constructor to this class: public demo(String, Exception)
- Add the constructor public demo (String s, Exception e) : base(s, e) { } to the class demo.
CA1032: Implement standard exception constructors: Microsoft.Design: Add the following constructor to this class: protected demo(SerializationInfo, StreamingContext)
- Add the code using System.Runtime.Serialization; to the beginning of the Class1.cs file.
  
  Next, add the constructor protected demo (SerializationInfo info, StreamingContext context) : base(info, context) { } to the class demo.
  
  Rebuild the project.
CA1032: Implement standard exception constructors: Microsoft.Design: Add the following constructor to this class: public demo()
- Add the constructor public demo () : base() { } to the class demo.
  
  Rebuild the project.
CA1709: Identifiers should be cased correctly: Microsoft.Naming: Correct the casing of namespace name 'testCode' by changing it to 'TestCode'.
- Change the casing of the namespace testCode to TestCode.
CA1709: Identifiers should be cased correctly: Microsoft.Naming: Correct the casing of type name 'demo' by changing it to 'Demo'.
- Change the name of the member to Demo.
CA1709: Identifiers should be cased correctly: Microsoft.Naming: Correct the casing of member name 'item' by changing it to 'Item'.
- Change the name of the member to Item.
CA1710: Identifiers should have correct suffix: Microsoft.Naming: Rename 'testCode.demo' to end in 'Exception'.
- Change the name of the class and its constructors to DemoException.
CA2210: Assemblies should have valid strong names: Sign 'ManagedDemo' with a strong name key.
- On the Project menu, click ManagedDemo Properties.
  
  The project properties appear.
  
  Click Signing.
  
  Select the Sign the assembly check box.
  
  In the Choose a string name key file list, select <New…>.
  
  The Create Strong Name Key dialog box appears.
  
  In the Key file name, type TestKey.
  
  Enter a password and then click OK.
  
  On the File menu, click Save Selected Items, and then close the property pages.
  
  Rebuild the project.
CA2237: Mark ISerializable types with SerializableAttribute: Microsoft.Usage: Add a [Serializable] attribute to type 'demo' as this type implements ISerializable.
- Add the [Serializable ()] attribute to the class demo.
  
  Rebuild the project.
After you complete the changes, the Class1.cs file should look like the following:

//CodeAnalysisManagedDemo
//Class1.cs
using System;
using System.Runtime.Serialization;

namespace TestCode
{

    [Serializable()]
    public class DemoException : Exception
    {
        public DemoException () : base() { }
        public DemoException(String s) : base(s) { }
        public DemoException(String s, Exception e) : base(s, e) { }
        protected DemoException(SerializationInfo info, StreamingContext context) : base(info, context) { }

        public static void Initialize(int size) { }
        protected static readonly int _item;
        public static int Item { get { return _item; } }
    }
}

Exclude Code Analysis Warnings

To exclude code defect warnings

For each of the remaining warnings, do the following:
1. In the Code Analysis window, select the warning.
2. Choose Actions, then choose Suppress Message, and then choose In Project Suppression File.
  
  For more information, see How to: Suppress Warnings by Using the Menu Item
Rebuild the project.

The project builds without any warnings or errors.

Partager via