Skip to content

Commit 6b7e950

Browse files
authored
Address post-merge comments (#44984)
See #44968
1 parent a0f42b1 commit 6b7e950

File tree

1 file changed

+2
-2
lines changed
  • docs/csharp/language-reference/xmldoc

1 file changed

+2
-2
lines changed

docs/csharp/language-reference/xmldoc/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This process provides many advantages for you to add API documentation in your c
2525

2626
Tools like Visual Studio provide IntelliSense for many common XML elements used in documentation comments.
2727

28-
This article covers these articles:
28+
This article covers these topics:
2929

3030
- Documentation comments and XML file generation
3131
- Tags validated by the C# compiler and Visual Studio
@@ -102,7 +102,7 @@ The use of XML doc comments requires delimiters that indicate where a documentat
102102
To refer to XML elements (for example, your function processes specific XML elements that you want to describe in an XML documentation comment), you can use the standard quoting mechanism (`<` and `>`). To refer to generic identifiers in code reference (`cref`) elements, you can use either the escape characters (for example, `cref="List<T>"`) or braces (`cref="List{T}"`). As a special case, the compiler parses the braces as angle brackets to make the documentation comment less cumbersome to the author when referring to generic identifiers.
103103

104104
> [!NOTE]
105-
> If you write comments using the single line XML comment delimiter, `///`, but don't include any tags, the compiler adds the text of those comments to the XML output file. However, the output doesn't include XML elements such as `<summary>`. Most tools that consume XML comments (including Visual Studio intellisense) don't read these comments.
105+
> If you write comments using the single line XML comment delimiter, `///`, but don't include any tags, the compiler adds the text of those comments to the XML output file. However, the output doesn't include XML elements such as `<summary>`. Most tools that consume XML comments (including Visual Studio IntelliSense) don't read these comments.
106106
107107
## Tools that accept XML documentation input
108108

0 commit comments

Comments
 (0)