Add documentation for missing HTML formatting tags in C# XML documentation #47053
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.
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 explanationAdded guidance for deprecated tag:
<tt>
being deprecated with recommendation to use<c>
insteadUpdated table of contents:
Each new section includes:
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