Add examples for XML on extension members
#50551
Merged
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
Fixes dotnet#49956 Add examples and explanations for writing documentation on `extension` nodes. Include how the XML comments on the `extension` node for `<summary>`, `<param>` and `<typeparam>` are copied to all members of that extension block.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive XML documentation examples for C# extension members, demonstrating how to properly document extension blocks and their members. The changes update the target framework to .NET 10.0 and add documentation showing that XML comments on extension blocks are copied to all members within that block.
Key Changes
- Added new "Extension members" section to XML documentation examples
- Included XML comments for all extension examples showing proper documentation patterns
- Updated target framework from net8.0 to net10.0
- Applied markdown style improvements for consistency with .NET documentation guidelines
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/csharp/language-reference/xmldoc/snippets/xmldoc/xmldoc.csproj | Updated target framework to net10.0 |
| docs/csharp/language-reference/xmldoc/snippets/xmldoc/DocComments.cs | Added new extension example with XML comments demonstrating documentation for extension blocks and members |
| docs/csharp/language-reference/xmldoc/examples.md | Added "Extension members" section explaining XML documentation for extension blocks, plus style improvements |
| docs/csharp/language-reference/keywords/snippets/Extensions.cs | Added comprehensive XML comments to existing extension examples |
| docs/csharp/language-reference/keywords/extension.md | Added note about XML documentation patterns and style improvements |
gewarren
approved these changes
Dec 11, 2025
docs/csharp/language-reference/xmldoc/snippets/xmldoc/DocComments.cs
Outdated
Show resolved
Hide resolved
docs/csharp/language-reference/xmldoc/snippets/xmldoc/DocComments.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: Genevieve Warren <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fixes #49956
Add examples and explanations for writing documentation on
extensionnodes.Include how the XML comments on the
extensionnode for<summary>,<param>and<typeparam>are copied to all members of that extension block.Internal previews