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.

Sign up for GitHub

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
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
622bc6a
Initial plan
Copilot Jul 1, 2025
3a1c671
Add documentation for missing HTML formatting tags in XML documentation
Copilot Jul 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions docs/csharp/language-reference/xmldoc/recommended-tags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,11 @@ The compiler verifies the syntax of the elements followed by a single \* in the
- [`<c>`](#c)
- [`<code>`](#code)
- [`<example>`](#example) \*\*
- [`<b>`](#b)
- [`<i>`](#i)
- [`<u>`](#u)
- [`<br/>`](#br)
- [`<a>`](#a)
- [Reuse documentation text](#reuse-documentation-text) - These tags provide tools that make it easier to reuse XML comments.
- [`<inheritdoc>`](#inheritdoc) \*\*
- [`<include>`](#include) \*
Expand Down Expand Up @@ -303,6 +308,49 @@ This shows how to increment an integer.

The `<example>` tag lets you specify an example of how to use a method or other library member. An example commonly involves using the [\<code>](#code) tag.

### \<b>

```xml
<b>text</b>
```

The `<b>` tag is used to make text bold within documentation comments. This HTML formatting tag is validated by the compiler and Visual Studio, and the formatted text appears in IntelliSense and generated documentation.

### \<i>

```xml
<i>text</i>
```

The `<i>` tag is used to make text italic within documentation comments. This HTML formatting tag is validated by the compiler and Visual Studio, and the formatted text appears in IntelliSense and generated documentation.

### \<u>

```xml
<u>text</u>
```

The `<u>` tag is used to underline text within documentation comments. This HTML formatting tag is validated by the compiler and Visual Studio, and the formatted text appears in IntelliSense and generated documentation.

### \<br/>

```xml
Line one<br/>Line two
```

The `<br/>` tag is used to insert a line break within documentation comments. Use this tag when you want a single spaced paragraph, as opposed to the `<para>` tag which creates double spaced paragraphs.

### \<a>

```xml
<a href="https://example.com">Link text</a>
```

The `<a>` tag is used to create hyperlinks within documentation comments. The `href` attribute specifies the URL to link to. This HTML formatting tag is validated by the compiler and Visual Studio.

> [!NOTE]
> The compiler also validates the `<tt>` tag, which is deprecated HTML. Use the [`<c>`](#c) tag instead for inline code formatting.

## Reuse documentation text

### \<inheritdoc>
Expand Down
Loading