[Docs] Enhance XML comment examples in documentation #10684
Draft
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.
This PR improves the documentation regarding XML comment examples in DocFX by:
Enhancing the existing example in
basic-concepts.md
to include more XML comment tags:<exception>
,<example>
,<seealso>
,<paramref>
, and enhanced<remarks>
with multiple paragraphs<see>
tags with bothcref
andhref
attributesCreating a new dedicated page
xml-comment-examples.md
with comprehensive examples:Adding a reference from
basic-concepts.md
to the new examples page:Updated the table of contents to include the new examples page:
These changes provide users with a more comprehensive overview of XML comment support in DocFX, making it easier to understand and utilize the full range of documentation capabilities.
Fixes #9165.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
learn.microsoft.com
curl -s REDACTED
(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.