CSHARP.DEBUG.LOG : Debug Warning (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.DEBUG.LOG : Debug Warning (C#)

Summary

A method should be replaced with a logging code in production code.

For example, Console.WriteLine() should be not used in production code.

Some operations should not be performed in production code, since they have no effect or have unpredictable effects, or since they might compromise the availability or security of your system.

Properties

Class Name

Debug Warning (C#)

Significance

reliability

Mnemonic

CSHARP.DEBUG.LOG

Example

using System;

namespace DocumentationExamples
{


    public class Production
    {
        public static void Main(string[] args)
        {
            Check(args.Length);
        }
        public static void Check(int k)
        {
            if (k <= 0)
                Environment.Exit(-1); // Debug Call (C#) warning issued here 
            else
                Console.WriteLine(k); // Debug Warning (C#) warning issued here 
        }
    }
}

In this example, the programmer should signal the unusual situation in other ways, for instance by throwing an exception or by showing a dialog to the user, then finish the run correctly.

Resolution

Verify if the operation is adequate for production code. Remove it or transform it if that is not the case.

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/.