XML documentation from interfaces or base classes is not inherited
See original GitHub issueI have the following code
public interface IItemFilter
{
/// <summary>
/// Get the whitelist of zone IDs to include.
/// If <c>null</c> include everything.
/// </summary>
[CanBeNull]
int[] ZoneIds { get; }
}
and
public sealed class ItemFilter : IItemFilter
{
[CanBeNull]
public int[] ZoneIds { get; set; }
}
When hovering over IItemFilter.ZoneIds
I get the description when hovering over ItemFilter.ZoneIds
I don’t 😦
Thanks for looking into the issue.
Issue Analytics
- State:
- Created 8 years ago
- Comments:10 (5 by maintainers)
Top Results From Across the Web
Inheriting comments from an interface in an implementing ...
That said, in our code base we put XML comments on the interfaces only and add extra implementation comments to the class.
Read more >Using the <inheritdoc /> Tag
Its use on any other member type will result in no comments being inherited unless a cref attribute is specified. Note that the...
Read more >Recommended XML tags for C# documentation comments
Inherit XML comments from base classes, interfaces, and similar methods. Using inheritdoc eliminates unwanted copying and pasting of ...
Read more >Inherit Documentation in C# - GeeksforGeeks
The C# programming language documentation tag <inheritdoc/> states that a documentation comment must inherit documentation from a base class ...
Read more >Inherit XML Documentation Comments in C# - Improve & Repeat
A simple solution for this problem is to inherit the documentation that should be the same. We can do that with the keyword...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
That’s not specific to Enhanced Tooltip: the plugin reuses the documentation provided by ReSharper here, and R# doesn’t automatically looks for the XML doc on the interface.
That’s said, the plugin is supposed to enhance the standard tooltip so I can mark this as a feature request 😃
I’ll close this issue since ReSharper now supports
<inheritdoc />
for this exact purpose, which Enhanced Tooltip gets for free.