SA1405.md

SA1405

TypeName	SA1405DebugAssertMustProvideMessageText
CheckId	SA1405
Category	Maintainability Rules

Cause

A call to Debug.Assert 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.Assert which does not provide a description for the end-user. For example, the following assert includes a description message:

Debug.Assert(value != true, "The value must always be true.");

How to fix violations

To fix a violation of this rule, add a descriptive message to the assert which will appear to the end user when the assert is fired.

How to suppress violations

[SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1405:DebugAssertMustProvideMessageText", Justification = "Reviewed.")]

#pragma warning disable SA1405 // DebugAssertMustProvideMessageText
#pragma warning restore SA1405 // DebugAssertMustProvideMessageText