CSHARP.STRUCT.UNFLD : Unnecessary Field (C#)

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

CodeSonar^® 9.2p0

CONFIDENTIAL

CodeSecure Inc

CSHARP.STRUCT.UNFLD : Unnecessary Field (C#)

Summary

One of the following.

A field is only used in a constructor and could hence be replaced by a local variable.
A field is only used inside a static initializer and could hence be replaced by a local variable.
A field should be replaced by local variables inside the methods that use it.
A field is updated but the written value is never used later.

Properties

Class Name

Unnecessary Field (C#)

Significance

reliability

Mnemonic

CSHARP.STRUCT.UNFLD

Example

namespace DocumentationExamples
{

    public class ImproperField
    {
        public static void Main(string[] args)
        { }

        private int[] array = new int[100];
        private int counter;  // "Unnecessary Field (C#)" warning issued here
                              // - 'counter' should be replaced by local variables.

        public void Clear()
        {
            for (counter = 0; counter < array.Length; counter++)
                array[counter] = 1;
            counter = 0;      // "Unnecessary Field (C#)" warning issued here
                              // - value never used
        }
        
        private int field1;   // "Unnecessary Field (C#)" warning issued here
                              // - field1 only used in constructors
        public ImproperField(){
            field1 = 0;
            field1 = field1+1;
        }
    }
}

These issues can be resolved by removing the counter field (using a local variable instead), and by marking field1 as readonly.

namespace DocumentationExamples
{

    public class ImproperField
    {
        public static void Main(string[] args)
        { }

        private int[] array = new int[100];

        public void Clear()
        {
            for (int counter = 0; counter < array.Length; counter++)
                array[counter] = 1;
        }
        
        private readonly int field1;
        public ImproperField(){
            field1 = 0;
            field1 = field1+1;
        }
    }
}

Resolution

Use variables local to the methods and the constructors instead of fields.

Relevant Configuration File Parameters

The following configuration file parameters affect checks for this warning class.

To report problems with this documentation, please visit https://support.codesecure.com/.