Problem with XML doc comment inspection
I have the folloowing XM doc comment:
The variable "attribute" is defined as a member variable of the class. The comment is rendered correct
Resharper suggest to convert the paramref to a nested attribute. If i do this the variable isn't displayed in the comment anymore:
As i use the code from an existing project i'm not sure if this is a misbeahiour of R# or if my coworker used the tags incorrect.
Please sign in to leave a comment.
<paramref> is supposed to refer to one of the method's parameters, not a property of one of the parameters:
<paramref> (C# Programming Guide) | Microsoft Docs
Even if it was allowed to refer to a property of a parameter, you would need some way to indicate which parameter the property belongs to.
The tool-tip doesn't try to validate the name of the parameter; it just assumes it's correct and displays the name in bold.
Thanks for the clarification. I'm glad that it's not a R# problem :-))