Skip to content

Add documentation for missing HTML formatting tags in C# XML documentation #47053

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

Merged
merged 2 commits into from
Jul 2, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jul 1, 2025

The C# XML documentation page mentioned that the compiler and Visual Studio validate HTML formatting tags like <b>, <i>, <u>, <br/>, and <a>, but these tags lacked proper documentation sections explaining their usage.

Changes Made

Added comprehensive documentation for 5 HTML formatting tags:

  • <b> - for bold text formatting
  • <i> - for italic text formatting
  • <u> - for underlined text formatting
  • <br/> - for line breaks with cross-reference to <para> differences
  • <a> - for hyperlinks with href attribute explanation

Added guidance for deprecated tag:

  • Note about <tt> being deprecated with recommendation to use <c> instead

Updated table of contents:

  • Added proper anchor links for all new sections in the "Format documentation output" section
  • Maintained consistent formatting with existing entries

Each new section includes:

  • Clear XML syntax examples
  • Detailed descriptions of purpose and behavior
  • Notes about compiler and Visual Studio validation
  • Information about how they appear in IntelliSense and generated documentation

Issue Clarification

The original issue incorrectly stated that <code> documentation was missing - it already had complete documentation at lines 281-290. The actual missing elements were the HTML formatting tags that were mentioned but not documented.

Fixes #18918.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.


Internal previews

📄 File 🔗 Preview link
docs/csharp/language-reference/xmldoc/recommended-tags.md docs/csharp/language-reference/xmldoc/recommended-tags

Co-authored-by: BillWagner <493969+BillWagner@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] Missing elements Add documentation for missing HTML formatting tags in C# XML documentation Jul 1, 2025
@Copilot Copilot AI requested a review from BillWagner July 1, 2025 18:11
Copilot finished work on behalf of BillWagner July 1, 2025 18:11
Copy link
Member

@BillWagner BillWagner 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 great. Let's mark it ready for final review.

@BillWagner BillWagner marked this pull request as ready for review July 2, 2025 13:01
@BillWagner BillWagner requested a review from a team as a code owner July 2, 2025 13:01
@BillWagner BillWagner enabled auto-merge (squash) July 2, 2025 13:01
@BillWagner BillWagner requested a review from IEvangelist July 2, 2025 13:01
@BillWagner BillWagner merged commit bdd935e into main Jul 2, 2025
15 checks passed
@BillWagner BillWagner deleted the copilot/fix-18918 branch July 2, 2025 14:17
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.

Missing elements
3 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy