Update SA1004 to allow doc comments to start with the in, out and ref keywords #3836
Conversation
bjornhellander
force-pushed
the
feature/sa1004-param-modifier-3817
branch
from
64bf2b4 to
d3c8af2
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #3836 +/- ##
==========================================
+ Coverage 94.38% 97.45% +3.07%
==========================================
Files 925 926 +1
Lines 110065 110136 +71
Branches 3307 3311 +4
==========================================
+ Hits 103881 107332 +3451
+ Misses 5174 1837 -3337
+ Partials 1010 967 -43 |
bjornhellander
force-pushed
the
feature/sa1004-param-modifier-3817
branch
from
d3c8af2 to
a1909e0
Compare
| string testCode = $@" | ||
| /// <summary> | ||
| /// Description of some remarks that refer to a method: <see cref=""SomeMethod(int, int, | ||
| /// {keyword} string)""/>. |
There was a problem hiding this comment.
Do we also need to check this wrapping?
/// <see cref="SomeMethod(int, int, ref
/// readonly string)"/>
There was a problem hiding this comment.
Technically, yes. I realized the same thing when I implemented this, but it seemed like a very rare case. Wait until someone actually reports it? :-) It won't take long if you think it is worth the time, but at that time I just skipped it.
There was a problem hiding this comment.
To me it seems similar to the current report. I think most users would not wrap a comment in the middle of a cref attribute, but automatic word wrapping tools can do it.
There was a problem hiding this comment.
No problem. Added.
Fixes #3817