Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 1.06 KB

SA1406.md

File metadata and controls

43 lines (32 loc) · 1.06 KB
Raw

SA1406

TypeName SA1406DebugFailMustProvideMessageText
CheckId SA1406
Category Maintainability Rules

Cause

A call to Debug.Fail in C# code does not include a descriptive message.

Rule description

A violation of this rule occurs when the code contains a call to Debug.Fail which does not provide a description for the end-user. For example, the following call includes a description message:

Debug.Fail("The code should never reach this point.");

How to fix violations

To fix an instance of this violation, add a descriptive message to the Debug.Fail call which will appear to the end user when the assert is fired.

How to suppress violations

[SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1406:DebugFailMustProvideMessageText", Justification = "Reviewed.")]
#pragma warning disable SA1406 // DebugFailMustProvideMessageText
#pragma warning restore SA1406 // DebugFailMustProvideMessageText