SA1406: DebugFailMustProvideMessageText

StyleCop

TypeName

DebugFailMustProvideMessageText

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.