Navigation:  StyleCop 4.3 > StyleCop 4.3 Rules > Maintainability Rules >

SA1405: DebugAssertMustProvideMessageText

Previous pageReturn to chapter overviewNext page
StyleCop 4.3

Send comments on this topic.

SA1405: DebugAssertMustProvideMessageText

Glossary Item Box

TypeName
DebugAssertMustProvideMessageText

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.

 


© Microsoft Corporation. All Rights Reserved.