-
Notifications
You must be signed in to change notification settings - Fork 6k
Add Xml docs tutorial #49137
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Xml docs tutorial #49137
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a comprehensive XML documentation tutorial to the C# fundamentals section and modernizes existing code examples. The tutorial teaches developers how to create effective XML documentation comments using the object-oriented programming sample as a foundation.
- Introduces XML documentation concepts and demonstrates practical implementation
- Updates Transaction class to use modern record syntax across multiple tutorials
- Refreshes dates and language in existing object-oriented programming tutorials
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
File | Description |
---|---|
docs/csharp/fundamentals/tutorials/xml-documentation.md | New tutorial covering XML documentation comments with practical examples |
docs/csharp/fundamentals/tutorials/snippets/xml-documentation/*.cs | Complete code examples with comprehensive XML documentation |
docs/csharp/fundamentals/tutorials/snippets/*/transaction.cs | Modernized Transaction class to use record syntax |
docs/csharp/fundamentals/tutorials/oop.md | Updated language and dates for clarity |
docs/csharp/fundamentals/tutorials/classes.md | Updated language and dates for clarity |
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me. Is there any value in adding screen shots of rendered XML comments on APIs to help visualize the result?
docs/csharp/fundamentals/tutorials/snippets/xml-documentation/BankAccount.cs
Outdated
Show resolved
Hide resolved
docs/csharp/fundamentals/tutorials/snippets/xml-documentation/BankAccount.cs
Outdated
Show resolved
Hide resolved
docs/csharp/fundamentals/tutorials/snippets/xml-documentation/BankAccount.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: David Pine <[email protected]>
Fixes #27639
Add a tutorial for XML documentation that takes the previous Object oriented tutorial and adds XML comments.
I also updated some of the code constructs in the related preceding tutorials.
Internal previews