Use snippets in article #50263
Merged
Use snippets in article #50263
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
Responding to dotnet#50244 These files should remain in the repo, and should generally be included in the article
Contributor
There was a problem hiding this comment.
Pull request overview
This PR integrates code snippets from separate files into the XML documentation tutorial article, replacing inline code examples with references to full source files. The changes improve maintainability by using the standard snippet reference pattern instead of duplicating code in the documentation.
Key changes:
- Added snippet references to the markdown article for
Transactionrecord andBankAccountclass examples. - Updated derived classes (
InterestEarningAccount,LineOfCreditAccount,GiftCardAccount) to use<inheritdoc/>tags, demonstrating XML documentation inheritance. - Added snippet markers to
InterestEarningAccount.csto enable selective code inclusion in the article. - Cleaned up unnecessary comments from
BankAccount.cs.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/csharp/fundamentals/tutorials/xml-documentation.md | Added code snippet references and link to source repository; removed inline code example for <inheritdoc/> usage |
| docs/csharp/fundamentals/tutorials/snippets/xml-documentation/BankAccount.cs | Removed extraneous comment line for cleaner code presentation |
| docs/csharp/fundamentals/tutorials/snippets/xml-documentation/InterestEarningAccount.cs | Added snippet markers and replaced detailed <summary> with <inheritdoc/> to demonstrate documentation inheritance |
| docs/csharp/fundamentals/tutorials/snippets/xml-documentation/LineOfCreditAccount.cs | Replaced detailed <summary> with <inheritdoc/> to demonstrate documentation inheritance pattern |
| docs/csharp/fundamentals/tutorials/snippets/xml-documentation/GiftCardAccount.cs | Replaced detailed <summary> with <inheritdoc/> to demonstrate documentation inheritance pattern |
BillWagner
commented
Dec 2, 2025
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
gewarren
approved these changes
Dec 2, 2025
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.
Responding to #50244
These files should remain in the repo, and should generally be included in the article
Internal previews