2
Vote

Add a new rule to detect documentation header text which contains 2 consecutive periods

description

In our codebase we've often seen documentation header text like this:
/// <summary>Specifies attributes of a widget message..</summary>
Notice that the text ends with two periods instead of one.

Would be great if there was a StyleCop rule to find this type of thing.

Note: The rule should not trigger in the case of 3 consecutive periods (i.e. an ellipsis).

comments

Rob263 wrote Sep 7, 2016 at 5:24 PM

We agreed that the rule should find any 2 consecutive periods - not just ones at the end of the text. This makes sense since the text often contains multiple sentences, and we want to find any of them which end with an accidental double-period.

Updated the title of the issue to match.

Rob263 wrote Mar 22 at 7:55 PM