Skip to content

Commit a3702c0

Browse files
committed
touchups
1 parent 63d3580 commit a3702c0

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This article describes how Visual Studio can help you document code elements suc
1515
You can distribute the compiler-generated XML file along with your .NET assembly so that Visual Studio and other IDEs can use IntelliSense to show quick information about types and members. You can also run the XML file through tools like [DocFX](https://dotnet.github.io/docfx/) and [Sandcastle](https://www.microsoft.com/download/details.aspx?id=10526) to generate API reference websites.
1616

1717
> [!NOTE]
18-
> The **Insert Comment** command to automatically insert XML documentation comment structure is available in [C#](/dotnet/csharp/programming-guide/xmldoc/) and [Visual Basic](/dotnet/visual-basic/programming-guide/program-structure/how-to-create-xml-documentation). For C++, you can [manually insert XML documentation comments](/cpp/build/reference/xml-documentation-visual-cpp) and generate XML documentation files at compile time.
18+
> The **Insert Comment** command to automatically insert XML documentation comment structure is available in [C#](/dotnet/csharp/programming-guide/xmldoc/) and [Visual Basic](/dotnet/visual-basic/programming-guide/program-structure/how-to-create-xml-documentation). For C++, you can [manually insert XML documentation comments](/cpp/build/reference/xml-documentation-visual-cpp) and still generate XML documentation files at compile time.
1919
2020
## Enable documentation generation
2121

@@ -85,7 +85,7 @@ You can set the [Comments](options-text-editor-csharp-advanced.md#comments) opti
8585
```
8686
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:
88+
For example, enter the following code into a C# program file:
8989

9090
```csharp
9191
/// <summary>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,5 +214,5 @@ The following XML shows a code snippet that uses the method `File.Exists` in the
214214

215215
## Related content
216216

217-
- For a reference to the Visual Studio IntelliSense Code Snippet XML schema, see [Code snippets schema reference](code-snippets-schema-reference.md).
217+
- For the Visual Studio IntelliSense Code Snippet XML schema reference, see [Code snippets schema reference](code-snippets-schema-reference.md).
218218
- 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)