SA1631 caused by regex expression in <param> tag

Mar 8, 2012 at 12:00 PM

In our documentation we supply regex examples in our <param> tags to specify valid values:

/// <param name="introductionText">
/// Introduction Text - ^[\w\s\-/?.,:;'()�$�@!]{1,255}$
/// </param>
(the two bad symbols in there are GBP and EUR symbols, not sure why they aren't displaying properly)

Since upgrading to 4.7.x this is now flagged as:

SA1631: The documentation text within the param tag does not appear to follow a proper grammatical structure required for documentation text.

It wasn't flagged before.

Is this correct behaviour?

If so, what is the best way to keep these regex expressions in the documentation?

Nov 18, 2014 at 2:39 AM
I created a work item here: