Skip to content

Commit 363f3ac

Browse files
committed
some edits
1 parent 2a84d97 commit 363f3ac

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

docs/ide/reference/generate-xml-documentation-comments.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ You can distribute the compiler-generated XML file along with your .NET assembly
1919
2020
## Enable documentation generation
2121

22-
To enable documentation generation, select **Generate a file containing API documentation** on the **Build** > **Output** tab of your project's properties.
22+
To enable documentation generation, select the **Generate a file containing API documentation** checkbox on the **Build** > **Output** tab of your project's properties.
2323

24-
By default, a documentation file named the same as your assembly with an *.xml* file extension is generated in the same directory as the assembly. If you want to configure a non-default name or location for the file, enter or browse to an alternate location under **XML documentation file path**.
24+
By default, the documentation file is named the same as your assembly with an *.xml* file extension and placed in the same directory as the assembly. If you want to configure a nondefault name or location for the file, enter or browse to an alternate location under **XML documentation file path**.
2525

2626
Alternatively, you can add the [GenerateDocumentationFile](/dotnet/core/project-sdk/msbuild-props#generatedocumentationfile) or [DocumentationFile](/dotnet/core/project-sdk/msbuild-props#documentationfile) properties to your *.csproj*, *.vbproj*, or *.fsproj* file. Set `GenerateDocumentationFile` to `true` to generate a documentation file with the default name and location. Add the `DocumentationFile` property to specify a different name or location.
2727

@@ -47,8 +47,8 @@ You can set the [Comments](options-text-editor-csharp-advanced.md#comments) opti
4747

4848
The XML comment structure is immediately generated above the code element. For example, when commenting a method, the template generates the `<summary>` element, a `<param>` element for each parameter, and a `<returns>` element to document the return value.
4949

50-
```csharp
51-
/// <summary>
50+
```csharp
51+
/// <summary>
5252
///
5353
/// </summary>
5454
/// <param name="id"></param>
@@ -57,7 +57,7 @@ You can set the [Comments](options-text-editor-csharp-advanced.md#comments) opti
5757
{
5858
return "username";
5959
}
60-
```
60+
```
6161

6262
```vb
6363
''' <summary>
@@ -83,7 +83,7 @@ You can set the [Comments](options-text-editor-csharp-advanced.md#comments) opti
8383
return "username";
8484
}
8585
```
86-
You can use styles in XML comments that render in Quick Info when you hover over the element. These styles include italics, bold, bulleted or numbered lists, and clickable `cref` or `href` links.
86+
You can use XML elements and styles in comments that render in Quick Info when you hover over the element. These elements include italics, bold, bulleted or numbered lists, and clickable `cref` or `href` links.
8787

8888
For example, enter the following code in Visual Studio:
8989

docs/ide/walkthrough-creating-a-code-snippet.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ You can create your own code snippets and add them to the code snippets that Vis
5656

5757
1. Enter the title *Square Root* into the snippet `Title` element.
5858

59-
1. In the **Language** attribute of the `Code` element, fill in **CSharp** for a #C snippet ot **VB** for Visual Basic.
59+
1. In the **Language** attribute of the `Code` element, fill in **CSharp** for a #C snippet or **VB** for Visual Basic.
6060

6161
> [!TIP]
6262
> To see all the available language values, see [Attributes](code-snippets-schema-reference.md#attributes) in the [Code snippets schema reference](code-snippets-schema-reference.md).
@@ -127,7 +127,7 @@ The description field provides more information about your code snippet when vie
127127
<Header>
128128
<Title>Square Root</Title>
129129
<Author>Myself</Author>
130-
<Description>Calculates the square root of a number.</Description>
130+
<Description>Calculates the square root of 16.</Description>
131131
<Shortcut>sqrt</Shortcut>
132132
</Header>
133133
```
@@ -144,9 +144,9 @@ You might want the user to replace parts of a code snippet. For example, you mig
144144

145145
You can provide two types of replacements: literals and objects.
146146

147-
- Use the [Literal element](code-snippets-schema-reference.md#literal-element) to identify a replacement for a piece of code that's entirely contained within the snippet but can be customized after it's inserted into the code. For example a string or numeric value.
147+
- Use the [Literal](code-snippets-schema-reference.md#literal-element) element to identify a replacement for a piece of code entirely contained within the snippet that be customized after being inserted into the code. For example, a string or numeric value.
148148

149-
- Use the [Object element](code-snippets-schema-reference.md#object-element) to identify an item that's required by the code snippet but is probably defined outside of the snippet itself. For example, an object instance or a control.
149+
- Use the [Object](code-snippets-schema-reference.md#object-element) element to identify an item that the code snippet requires but is probably defined outside of the snippet itself. For example, an object instance or a control.
150150

151151
You can use a `Literal` element in the *SquareRoot.snippet* file to help users easily change the number to calculate the square root of.
152152

@@ -167,7 +167,7 @@ You can use a `Literal` element in the *SquareRoot.snippet* file to help users e
167167
</Snippet>
168168
```
169169

170-
Notice that the literal replacement gets an ID, `Number`. You reference that ID from within the code snippet by surrounding it with `$` characters, as follows:
170+
Notice that the literal replacement gets an ID, `Number`. You reference that ID in the code snippet by surrounding it with `$` characters, as follows:
171171

172172
```xml
173173
<![CDATA[double root = Math.Sqrt($Number$);]]>
@@ -186,9 +186,9 @@ You can use a `Literal` element in the *SquareRoot.snippet* file to help users e
186186
187187
## Import a namespace
188188

189-
You can use a code snippet to add a `using` directive (C#) or `Imports` statement (Visual Basic) by including the [Imports element](code-snippets-schema-reference.md#imports-element). For .NET Framework projects, you can also add a reference to the project by using the [References element](code-snippets-schema-reference.md#references-element).
189+
You can use a code snippet to add a `using` directive (C#) or `Imports` statement (Visual Basic) by including the [Imports](code-snippets-schema-reference.md#imports-element) element. For .NET Framework projects, you can also add a reference to the project by using the [References](code-snippets-schema-reference.md#references-element) element.
190190

191-
The following XML shows a code snippet that uses the method `File.Exists` in the System.IO namespace and, therefore, defines the **Imports** element to import the System.IO namespace.
191+
The following XML shows a code snippet that uses the method `File.Exists` in the `System.IO` namespace, and therefore defines the **Imports** element to import the `System.IO` namespace.
192192

193193
```xml
194194
<?xml version="1.0" encoding="utf-8"?>
@@ -215,4 +215,4 @@ The following XML shows a code snippet that uses the method `File.Exists` in the
215215
## Related content
216216

217217
- For a reference to the Visual Studio IntelliSense Code Snippet XML schema, see [Code snippets schema reference](code-snippets-schema-reference.md).
218-
- To create snippets in Visual Studio Code, see [Create your own snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_create-your-own-snippets)
218+
- To create snippets in Visual Studio Code, see [Create your own snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_create-your-own-snippets).

0 commit comments

Comments
 (0)