diff --git a/rules/S3236/rule.adoc b/rules/S3236/rule.adoc index f99f539d576..c9813063fcb 100644 --- a/rules/S3236/rule.adoc +++ b/rules/S3236/rule.adoc @@ -1,6 +1,6 @@ == Why is this an issue? -Caller information attributes: ``++CallerFilePathAttribute++``, ``++CallerLineNumberAttribute++``, and ``++CallerArgumentExpressionAttribute++`` provide a way to get information about the caller of a method through optional parameters. But the arguments for these optional parameters are only generated if they are not explicitly defined in the call. Thus, specifying the argument values defeats the purpose of the attributes. +Caller information attributes: `CallerFilePathAttribute`, `CallerLineNumberAttribute`, and `CallerArgumentExpressionAttribute` provide a way to get information about the caller of a method through optional parameters. But the arguments for these optional parameters are only generated if they are not explicitly defined in the call. Thus, specifying the argument values defeats the purpose of the attributes. === Noncompliant code example @@ -41,5 +41,5 @@ void MyMethod() === Exceptions -``++CallerMemberName++`` is not checked to avoid False-Positives with WPF/UWP applications. - +* `CallerMemberName` is not checked to avoid False-Positives with WPF/UWP applications. +* `System.Diagnostics.Debug.Assert` is excluded as a custom message from the developer is sometimes preferred as an explanation of the failed assertion.