Skip to content
ptittof57 edited this page Aug 15, 2015 · 5 revisions
<title>SA1405: DebugAssertMustProvideMessageText</title> <script src="script/helpstudio.js" type="text/javascript"></script> <script src="script/StandardText.js" type="text/jscript"></script>
<script type="text/jscript">WritePageTop(document.title);</script>

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.

How to Suppress Violations

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