2

Closed

SA1631 (grammar in documentation text) should ignore text in a <code> block

description

Hi.

Thank you for StyleCop 4.7.49.0.

"SA1631 : CSharp.Documentation : The documentation text within the summary tag does not appear to follow a proper grammatical structure required for documentation text." should ignore text in a <code> block.

For example, the following code unexpectedly violates that rule:
/// <summary>
/// Version 12.0.30723.00
/// </summary>
public static readonly Version Version12Dot0Dot30723Dot00 = new Version(12, 0, 30723, 0);
In any case, so does the following code:
/// <summary>
/// Version <c>12.0.30723.00</c>
/// </summary>
public static readonly Version Version12Dot0Dot30723Dot00 = new Version(12, 0, 30723, 0);
Notice that I wrapped the offending text in a <code> (<c>) block.

I recommend that text in a code block should not require proper grammar because it is indicated as code.

Thank you.
Closed Dec 1, 2016 at 5:11 AM by csdahlberg

comments

csdahlberg wrote Dec 1, 2016 at 5:11 AM

This appears to have been fixed. If not, feel free to open a new issue on https://github.com/StyleCop/StyleCop.