Skip to content

Commit 63d3580

Browse files
committed
fixes
1 parent 363f3ac commit 63d3580

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You can distribute the compiler-generated XML file along with your .NET assembly
2121

2222
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, 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**.
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

@@ -35,7 +35,7 @@ You can set the [Comments](options-text-editor-csharp-advanced.md#comments) opti
3535
1. In the **Options** dialog box, navigate to **Text Editor** > **C#** (or **Visual Basic**) > **Advanced**.
3636
1. Under the **Comments** section, select or deselect **Generate XML documentation comments for \\\\\\** (or **'''**).
3737

38-
## Automatically insert an XML comment structure
38+
## Automatically insert an XML comment
3939

4040
1. In Visual Studio, place your cursor above the element you want to document, for example a method.
4141

@@ -45,7 +45,7 @@ You can set the [Comments](options-text-editor-csharp-advanced.md#comments) opti
4545
- From the **Edit** menu, choose **IntelliSense** > **Insert Comment**.
4646
- From the right-click or context menu, choose **Snippet** > **Insert Comment**.
4747

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

5050
```csharp
5151
/// <summary>
@@ -68,9 +68,9 @@ You can set the [Comments](options-text-editor-csharp-advanced.md#comments) opti
6868
Public Function GetUserName(id As Integer) As String
6969
Return "username"
7070
End Function
71-
```
71+
```
7272

73-
1. Enter descriptions for each XML element to fully document the code element. For example:
73+
1. Enter descriptions for each XML element to fully document the code. For example:
7474

7575
```csharp
7676
/// <summary>
@@ -83,9 +83,9 @@ You can set the [Comments](options-text-editor-csharp-advanced.md#comments) opti
8383
return "username";
8484
}
8585
```
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.
8787

88-
For example, enter the following code in Visual Studio:
88+
For example, enter the following code:
8989

9090
```csharp
9191
/// <summary>
@@ -102,14 +102,14 @@ public static string GetUserName(int id)
102102
}
103103
```
104104

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:
106106

107-
![Screenshot showing the completed comment with style tags for a clickable link, a numbered list with italics, and bold formatting.](media/doc-style-cs.png)
107+
![Screenshot showing the completed comment with style tags for a clickable link, a numbered list, and italic and bold formatting.](media/doc-style-cs.png)
108108

109109
## Related content
110110

111111
- [Documentation comments](/dotnet/csharp/language-reference/xmldoc/)
112-
- [How to: Create XML documentation in Visual Basic](/dotnet/visual-basic/programming-guide/program-structure/how-to-create-xml-documentation)
112+
- [XML documentation in Visual Basic](/dotnet/visual-basic/programming-guide/program-structure/how-to-create-xml-documentation)
113113
- [Comments (C++)](/cpp/cpp/comments-cpp)
114114
- [XML Documentation (Visual C++)](/cpp/build/reference/xml-documentation-visual-cpp)
115-
- [Generate, fix, or refactor code](writing-code-in-the-code-and-text-editor.md#generate-fix-or-refactor-code)
115+
- [Code generation](../writing-code-in-the-code-and-text-editor.md#generate-fix-or-refactor-code)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -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](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.
148148

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

0 commit comments

Comments
 (0)