Skip to content

[Docs] Enhance XML comment examples in documentation #10684

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented May 27, 2025

This PR improves the documentation regarding XML comment examples in DocFX by:

  1. Enhancing the existing example in basic-concepts.md to include more XML comment tags:

    • Added <exception>, <example>, <seealso>, <paramref>, and enhanced <remarks> with multiple paragraphs
    • Updated the code sample to demonstrate exception handling
    • Added <see> tags with both cref and href attributes
  2. Creating a new dedicated page xml-comment-examples.md with comprehensive examples:

    • Organized examples into logical sections (Basic, Advanced, Formatting)
    • Included examples for all major XML comment tags supported by DocFX
    • Added complex examples demonstrating how multiple tags can be used together
    • Included references to Microsoft's documentation for further reading
  3. Adding a reference from basic-concepts.md to the new examples page:

    • Added a paragraph explaining that more XML comment examples are available
    • Linked to the new examples page
  4. Updated the table of contents to include the new examples page:

    • Added the new page under the "Get started" section

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
    • Triggering command: 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.

Co-authored-by: yufeih <511355+yufeih@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] [Docs Feature Request] Basic Concepts Page - Improve the example [Docs] Enhance XML comment examples in documentation May 27, 2025
@Copilot Copilot AI requested a review from yufeih May 27, 2025 07:28
Copilot finished work on behalf of yufeih May 27, 2025 07:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs Feature Request] Basic Concepts Page - Improve the example
2 participants