Stylecopanalyzers: SA1629 should accept more punctuation

Created on 12 Jun 2018  路  9Comments  路  Source: DotNetAnalyzers/StyleCopAnalyzers

Using 1.1.0-beta007 I'm seeing a warning when a <remark> ends with an exclamation point.

image

enhancement needs discussion

Most helpful comment

Personally I think any punctuation such as !?. should be permitted.

All 9 comments

I can see both sides of this one. The counter-argument here is the comments in code probably shouldn't be yelling at the developer.

It's a remark, I feel I should be given a little more freedom.

Personally I think any punctuation such as !?. should be permitted.

I've marked this as an enhancement because I think there is merit in making the allowed punctuation configurable, with the default being only the period.

Another vote in favor of changing this. Colons are a valid case too:

///<remarks>
///     You should really check out this list:
///     <list>
///         <item>
///             <c>Item1</c>
///         </item>
///         <item>
///             <c>Item2</c>
///         </item>
///     </list>
/// </remarks>

@lennartb- Support for colons was added in #2720

@sharwell Ah, it's even already in beta 8, I hadn't updated from 7 yet! Nevermind then. 馃槃

here's another example of a bogus warning
/// <param name="message">Format string of the log message in message template format. Example: <c>"User {User} logged in from {Address}."</c></param>
if I remove the <c> tag, the warning goes away

@af4jm that's actually a separate issue. Can you file a new issue for it?

Was this page helpful?
0 / 5 - 0 ratings