Update <inheritdoc> documentation to clarify Visual Studio vs compiler behavior #47382
+5
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dotnet-policy-service
bot
added
dotnet-csharp/svc
lang-reference/subsvc
community-contribution
BillWagner
approved these changes
Jul 16, 2025
now.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses issue #47299 by updating the documentation for the
<inheritdoc>tag to clarify the difference between Visual Studio's automatic inheritance behavior and the compiler's XML output behavior.Changes made
<inheritdoc>section explaining that Visual Studio automatically inherits documentation for undocumented members in IntelliSense and Quick Info<inheritdoc>(for distributed libraries) vs when you can rely on VS's automatic behavior (for internal projects)Why this change is needed
The current documentation doesn't mention Visual Studio's automatic inheritance feature introduced in VS 2019 16.4, leading developers to unnecessarily add
<inheritdoc>tags to all inherited members. This update provides clarity on when the tag is actually needed.The note is placed immediately after the
crefandpathparameter descriptions to provide context about the different behaviors developers might encounter.Fixes #47299
Internal previews