Skip to content

Conversation

BillWagner
Copy link
Member

@BillWagner BillWagner commented Oct 14, 2025

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

📄 File 🔗 Preview link
docs/csharp/fundamentals/tutorials/classes.md Explore object oriented programming with classes and objects
docs/csharp/fundamentals/tutorials/oop.md "Object-Oriented Programming"
docs/csharp/fundamentals/tutorials/xml-documentation.md Tutorial: Create XML documentation

@BillWagner BillWagner requested a review from a team as a code owner October 14, 2025 19:57
@Copilot Copilot AI review requested due to automatic review settings October 14, 2025 19:57
@dotnetrepoman dotnetrepoman bot added this to the October 2025 milestone Oct 14, 2025
Copy link
Contributor

@Copilot Copilot AI left a 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

Copy link
Member

@IEvangelist IEvangelist left a 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?

@BillWagner BillWagner enabled auto-merge (squash) October 16, 2025 14:20
@BillWagner BillWagner merged commit 95fa3d3 into dotnet:main Oct 16, 2025
8 checks passed
@BillWagner BillWagner deleted the xml-docs-tutorial branch October 16, 2025 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Requesting for "XML documentation comments" page to be added to the C# Tutorials page.

2 participants