You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/csharp/language-reference/xmldoc/recommended-tags.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -192,7 +192,7 @@ The `<returns>` tag should be used in the comment for a method declaration to de
192
192
<paramname="name">description</param>
193
193
```
194
194
195
-
-`name`: The name of a method parameter. Enclose the name in double quotation marks (" "). The names for parameters must match the API signature. If one or more parameter aren't covered, the compiler issues a warning. The compiler also issues a warning if the value of `name` doesn't match a formal parameter in the method declaration.
195
+
-`name`: The name of a method parameter. Enclose the name in quotation marks ("). The names for parameters must match the API signature. If one or more parameter aren't covered, the compiler issues a warning. The compiler also issues a warning if the value of `name` doesn't match a formal parameter in the method declaration.
196
196
197
197
The `<param>` tag should be used in the comment for a method declaration to describe one of the parameters for the method. To document multiple parameters, use multiple `<param>` tags. The text for the `<param>` tag is displayed in IntelliSense, the Object Browser, and the Code Comment Web Report.
198
198
@@ -202,7 +202,7 @@ The `<param>` tag should be used in the comment for a method declaration to desc
202
202
<paramrefname="name"/>
203
203
```
204
204
205
-
-`name`: The name of the parameter to refer to. Enclose the name in double quotation marks (" ").
205
+
-`name`: The name of the parameter to refer to. Enclose the name in quotation marks (").
206
206
207
207
The `<paramref>` tag gives you a way to indicate that a word in the code comments, for example in a `<summary>` or `<remarks>` block refers to a parameter. The XML file can be processed to format this word in some distinct way, such as with a bold or italic font.
208
208
@@ -212,7 +212,7 @@ The `<paramref>` tag gives you a way to indicate that a word in the code comment
212
212
<exceptioncref="member">description</exception>
213
213
```
214
214
215
-
- cref = "`member`": A reference to an exception that is available from the current compilation environment. The compiler checks that the given exception exists and translates `member` to the canonical element name in the output XML. `member` must appear within double quotation marks (" ").
215
+
- cref = "`member`": A reference to an exception that is available from the current compilation environment. The compiler checks that the given exception exists and translates `member` to the canonical element name in the output XML. `member` must appear within quotation marks (").
216
216
217
217
The `<exception>` tag lets you specify which exceptions can be thrown. This tag can be applied to definitions for methods, properties, events, and indexers.
218
218
@@ -315,7 +315,7 @@ Add your XML comments in base classes or interfaces and let inheritdoc copy the
315
315
-`filename`: The name of the XML file containing the documentation. The file name can be qualified with a path relative to the source code file. Enclose `filename` in single quotation marks (' ').
316
316
-`tagpath`: The path of the tags in `filename` that leads to the tag `name`. Enclose the path in single quotation marks (' ').
317
317
-`name`: The name specifier in the tag that precedes the comments; `name` will have an `id`.
318
-
-`id`: The ID for the tag that precedes the comments. Enclose the ID in double quotation marks (" ").
318
+
-`id`: The ID for the tag that precedes the comments. Enclose the ID in quotation marks (").
319
319
320
320
The `<include>` tag lets you refer to comments in another file that describe the types and members in your source code. Including an external file is an alternative to placing documentation comments directly in your source code file. By putting the documentation in a separate file, you can apply source control to the documentation separately from the source code. One person can have the source code file checked out and someone else can have the documentation file checked out. The `<include>` tag uses the XML XPath syntax. Refer to XPath documentation for ways to customize your `<include>` use.
321
321
@@ -355,7 +355,7 @@ The XML output for this method is shown in the following example:
355
355
<seelangword="keyword"/>
356
356
```
357
357
358
-
-`cref="member"`: A reference to a member or field that is available to be called from the current compilation environment. The compiler checks that the given code element exists and passes `member` to the element name in the output XML. Place *member* within double quotation marks (" "). You can provide different link text for a "cref", by using a separate closing tag.
358
+
-`cref="member"`: A reference to a member or field that is available to be called from the current compilation environment. The compiler checks that the given code element exists and passes `member` to the element name in the output XML. Place *member* within quotation marks ("). You can provide different link text for a "cref", by using a separate closing tag.
359
359
-`href="link"`: A clickable link to a given URL. For example, `<see href="https://github.com">GitHub</see>` produces a clickable link with text :::no-loc text="GitHub"::: that links to `https://github.com`.
360
360
-`langword="keyword"`: A language keyword, such as `true` or one of the other valid [keywords](../keywords/index.md).
361
361
@@ -369,7 +369,7 @@ The `<see>` tag lets you specify a link from within text. Use [\<seealso>](#seea
369
369
<seealsohref="link">Link Text</seealso>
370
370
```
371
371
372
-
-`cref="member"`: A reference to a member or field that is available to be called from the current compilation environment. The compiler checks that the given code element exists and passes `member` to the element name in the output XML. `member` must appear within double quotation marks (" ").
372
+
-`cref="member"`: A reference to a member or field that is available to be called from the current compilation environment. The compiler checks that the given code element exists and passes `member` to the element name in the output XML. `member` must appear within quotation marks (").
373
373
-`href="link"`: A clickable link to a given URL. For example, `<seealso href="https://github.com">GitHub</seealso>` produces a clickable link with text :::no-loc text="GitHub"::: that links to `https://github.com`.
374
374
375
375
The `<seealso>` tag lets you specify the text that you might want to appear in a **See Also** section. Use [\<see>](#see) to specify a link from within text. You cannot nest the `seealso` tag inside the `summary` tag.
@@ -390,7 +390,7 @@ The `href` attribute means a reference to a web page. You can use it to directly
390
390
<typeparamname="TResult">The type returned from this method</typeparam>
391
391
```
392
392
393
-
-`TResult`: The name of the type parameter. Enclose the name in double quotation marks (" ").
393
+
-`TResult`: The name of the type parameter. Enclose the name in quotation marks (").
394
394
395
395
The `<typeparam>` tag should be used in the comment for a generic type or method declaration to describe a type parameter. Add a tag for each type parameter of the generic type or method. The text for the `<typeparam>` tag will be displayed in IntelliSense.
396
396
@@ -400,7 +400,7 @@ The `<typeparam>` tag should be used in the comment for a generic type or method
400
400
<typeparamrefname="TKey"/>
401
401
```
402
402
403
-
-`TKey`: The name of the type parameter. Enclose the name in double quotation marks (" ").
403
+
-`TKey`: The name of the type parameter. Enclose the name in quotation marks (").
404
404
405
405
Use this tag to enable consumers of the documentation file to format the word in some distinct way, for example in italics.
0 commit comments