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/ide/reference/generate-xml-documentation-comments.md
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ You can distribute the compiler-generated XML file along with your .NET assembly
21
21
22
22
To enable documentation generation, select the **Generate a file containing API documentation** checkbox on the **Build** > **Output** tab of your project's properties.
23
23
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**.
24
+
By default, a documentation file named the same as your assembly with an *.xml* file extension generates 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**.
25
25
26
26
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.
27
27
@@ -35,7 +35,7 @@ You can set the [Comments](options-text-editor-csharp-advanced.md#comments) opti
35
35
1. In the **Options** dialog box, navigate to **Text Editor** > **C#** (or **Visual Basic**) > **Advanced**.
36
36
1. Under the **Comments** section, select or deselect **Generate XML documentation comments for \\\\\\** (or **'''**).
37
37
38
-
## Automatically insert an XML comment structure
38
+
## Automatically insert an XML comment
39
39
40
40
1. In Visual Studio, place your cursor above the element you want to document, for example a method.
41
41
@@ -45,7 +45,7 @@ You can set the [Comments](options-text-editor-csharp-advanced.md#comments) opti
45
45
- From the **Edit** menu, choose **IntelliSense** > **Insert Comment**.
46
46
- From the right-click or context menu, choose **Snippet** > **Insert Comment**.
47
47
48
-
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.
48
+
The XML comment structure is immediately generated above the code element. For example, when commenting the following `GetUserName`method, the template generates the `<summary>` element, a `<param>` element for the parameter, and a `<returns>` element to document the return value.
49
49
50
50
```csharp
51
51
/// <summary>
@@ -68,9 +68,9 @@ You can set the [Comments](options-text-editor-csharp-advanced.md#comments) opti
68
68
PublicFunctionGetUserName(idAsInteger) AsString
69
69
Return"username"
70
70
EndFunction
71
-
```
71
+
```
72
72
73
-
1. Enter descriptions for each XML element to fully document the code element. For example:
73
+
1. Enterdescriptionsfor each XML element to fully document the code. For example:
74
74
75
75
```csharp
76
76
/// <summary>
@@ -83,9 +83,9 @@ You can set the [Comments](options-text-editor-csharp-advanced.md#comments) opti
83
83
return"username";
84
84
}
85
85
```
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.
86
+
You can use XML elements and styles in comments that render in Quick Info when you hover over the code. These elements include italic or bold styles, bulleted or numbered lists, and clickable `cref` or `href` links.
87
87
88
-
For example, enter the following code in Visual Studio:
88
+
For example, enter the following code:
89
89
90
90
```csharp
91
91
/// <summary>
@@ -102,14 +102,14 @@ public static string GetUserName(int id)
102
102
}
103
103
```
104
104
105
-
When you hover over **GetUserName**, the following formatting appears in the Quick Info pane:
105
+
When you hover over **GetUserName**, the Quick Info pane appears as follows:
106
106
107
-

107
+

Copy file name to clipboardExpand all lines: docs/ide/walkthrough-creating-a-code-snippet.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -144,9 +144,9 @@ You might want the user to replace parts of a code snippet. For example, you mig
144
144
145
145
You can provide two types of replacements: literals and objects.
146
146
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.
147
+
- Use the [Literal](code-snippets-schema-reference.md#literal-element) element to identify a replacement for code entirely contained within the snippet that can be customized after being inserted into the code. For example, a string or numeric value.
148
148
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.
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. For example, an object instance or a control.
150
150
151
151
You can use a `Literal` element in the *SquareRoot.snippet* file to help users easily change the number to calculate the square root of.
0 commit comments