Starting using DocumentationAnalyzers #21095
Conversation
|
/cc @sharwell |
| @@ -117,7 +117,7 @@ public override void Rollback() | |||
| /// Releases any resources used by the transaction and rolls it back. | |||
| /// </summary> | |||
| /// <param name="disposing"> | |||
| /// <see langword="talse"/> to release managed and unmanaged resources; | |||
| /// <see langword="true"/> to release managed and unmanaged resources; | |||
There was a problem hiding this comment.
What starts with "t" and is not false?
There was a problem hiding this comment.
That must be the 3-value logic thing everyone's been talking about...
|
Should we dump StyleCop? (We only use it for its documentation rules) |
There isn't a bunch of overlap between the two analyzer sets. Many of the rules in DocumentationAnalyzers were added after they were rejected from StyleCop Analyzers (most often for being too vague or too specific to certain developer scenarios). I'd need to see more details about which rules are used to give a better answer. |
|
For code style rules, the in-box experience from .editorconfig is intended to provide the most seamless experience. We're currently in the process of making a separate analyzer package for command line enforcement of these rules. Other analyzer packages generally have varying degrees of overlap while often offering unique features as well. Each analyzer incurs a small cost, so the team would need to decide which ones are providing the most overall value. |
No other rules--we just use it to check the correctness of XML docs (e.g. no Smit and (I think) Andriy maintain the .editorconfig file for enforcing our style guidelines. Personally, I'm against enforcing style at all since it limits artistic expression, but on the other hand, I agree that some level of consistency is needed. I definitely still want to enable more FxCop rules. I'm sure they'll catch some globalization bugs we've missed. |
One of the most important aspects in software engineering 😆 |
Just racking up the consistency points on a fine Monday morning.
Closes #21094