diff --git a/docs/csharp/language-reference/xmldoc/recommended-tags.md b/docs/csharp/language-reference/xmldoc/recommended-tags.md index 8f3b24554d736..a13a82552dc5b 100644 --- a/docs/csharp/language-reference/xmldoc/recommended-tags.md +++ b/docs/csharp/language-reference/xmldoc/recommended-tags.md @@ -133,6 +133,11 @@ The compiler verifies the syntax of the elements followed by a single \* in the - [``](#c) - [``](#code) - [``](#example) \*\* + - [``](#b) + - [``](#i) + - [``](#u) + - [`
`](#br) + - [``](#a) - [Reuse documentation text](#reuse-documentation-text) - These tags provide tools that make it easier to reuse XML comments. - [``](#inheritdoc) \*\* - [``](#include) \* @@ -303,6 +308,49 @@ This shows how to increment an integer. The `` tag lets you specify an example of how to use a method or other library member. An example commonly involves using the [\](#code) tag. +### \ + +```xml +text +``` + +The `` 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. + +### \ + +```xml +text +``` + +The `` 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. + +### \ + +```xml +text +``` + +The `` 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. + +### \
+ +```xml +Line one
Line two +``` + +The `
` 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 `` tag which creates double spaced paragraphs. + +### \
+ +```xml +Link text +``` + +The `` 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 `` tag, which is deprecated HTML. Use the [``](#c) tag instead for inline code formatting. + ## Reuse documentation text ### \