Skip to content

Commit 475a43e

Browse files
authored
Samwherever fix 41687 (#41723)
* Fix for 41687 * Additional work for fixing 41687, adjust for other mentions of double quotations
1 parent 135f351 commit 475a43e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/csharp/language-reference/xmldoc/recommended-tags.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ The `<returns>` tag should be used in the comment for a method declaration to de
192192
<param name="name">description</param>
193193
```
194194

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.
196196

197197
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.
198198

@@ -202,7 +202,7 @@ The `<param>` tag should be used in the comment for a method declaration to desc
202202
<paramref name="name"/>
203203
```
204204

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 (").
206206

207207
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.
208208

@@ -212,7 +212,7 @@ The `<paramref>` tag gives you a way to indicate that a word in the code comment
212212
<exception cref="member">description</exception>
213213
```
214214

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 (").
216216

217217
The `<exception>` tag lets you specify which exceptions can be thrown. This tag can be applied to definitions for methods, properties, events, and indexers.
218218

@@ -315,7 +315,7 @@ Add your XML comments in base classes or interfaces and let inheritdoc copy the
315315
- `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 (' ').
316316
- `tagpath`: The path of the tags in `filename` that leads to the tag `name`. Enclose the path in single quotation marks (' ').
317317
- `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 (").
319319

320320
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.
321321

@@ -355,7 +355,7 @@ The XML output for this method is shown in the following example:
355355
<see langword="keyword"/>
356356
```
357357

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.
359359
- `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`.
360360
- `langword="keyword"`: A language keyword, such as `true` or one of the other valid [keywords](../keywords/index.md).
361361

@@ -369,7 +369,7 @@ The `<see>` tag lets you specify a link from within text. Use [\<seealso>](#seea
369369
<seealso href="link">Link Text</seealso>
370370
```
371371

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 (").
373373
- `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`.
374374

375375
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
390390
<typeparam name="TResult">The type returned from this method</typeparam>
391391
```
392392

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 (").
394394

395395
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.
396396

@@ -400,7 +400,7 @@ The `<typeparam>` tag should be used in the comment for a generic type or method
400400
<typeparamref name="TKey"/>
401401
```
402402

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 (").
404404

405405
Use this tag to enable consumers of the documentation file to format the word in some distinct way, for example in italics.
406406

0 commit comments

Comments
 (0)