From 904fc8606a82437ba5c3ffd2a38cff51eb57b457 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 8 Sep 2025 18:33:01 +0000 Subject: [PATCH 1/9] Initial plan From fe41b168716682c40b33dd8b9484e37c5c879405 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 8 Sep 2025 18:40:54 +0000 Subject: [PATCH 2/9] Add missing typeparamref XML documentation tag for Visual Basic Co-authored-by: BillWagner <493969+BillWagner@users.noreply.github.com> --- .../language-reference/xmldoc/index.md | 1 + .../language-reference/xmldoc/typeparamref.md | 39 +++++++++++++++++++ .../VbVbcnXmlDocComments/VB/Class1.vb | 14 +++++++ 3 files changed, 54 insertions(+) create mode 100644 docs/visual-basic/language-reference/xmldoc/typeparamref.md diff --git a/docs/visual-basic/language-reference/xmldoc/index.md b/docs/visual-basic/language-reference/xmldoc/index.md index a5d42e130cf2d..b574812f86f04 100644 --- a/docs/visual-basic/language-reference/xmldoc/index.md +++ b/docs/visual-basic/language-reference/xmldoc/index.md @@ -37,6 +37,7 @@ The Visual Basic compiler can process documentation comments in your code to an - [\](seealso.md) 1 - [\](summary.md) - [\](typeparam.md) 1 +- [\](typeparamref.md) - [\](value.md) (1 The compiler verifies syntax.) diff --git a/docs/visual-basic/language-reference/xmldoc/typeparamref.md b/docs/visual-basic/language-reference/xmldoc/typeparamref.md new file mode 100644 index 0000000000000..e6c886b452cb8 --- /dev/null +++ b/docs/visual-basic/language-reference/xmldoc/typeparamref.md @@ -0,0 +1,39 @@ +--- +description: "Learn more about: (Visual Basic)" +title: "" +ms.date: 07/20/2015 +helpviewer_keywords: + - "typeparamref XML tag" + - " XML tag" +ms.assetid: 8979d53b-beb1-41b7-b41e-6bbea1c17a03 +--- +# \ (Visual Basic) + +Formats a word as a type parameter. + +## Syntax + +```xml + +``` + +## Parameters + + `name` + The name of the type parameter to refer to. Enclose the name in double quotation marks (" "). + +## Remarks + + The `` tag gives you a way to indicate that a word is a type parameter. The XML file can be processed to format this type parameter in some distinct way, for example in italics. + + Compile with [-doc](../../reference/command-line-compiler/doc.md) to process documentation comments to a file. + +## Example + + This example uses the `` tag to refer to the `T` type parameter. + + [!code-vb[VbVbcnXmlDocComments#9](~/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/Class1.vb#9)] + +## See also + +- [XML Comment Tags](index.md) diff --git a/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/Class1.vb b/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/Class1.vb index 70e2023aee777..c3ab51f528676 100644 --- a/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/Class1.vb +++ b/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/Class1.vb @@ -168,6 +168,20 @@ Public Class Test ' Code goes here. End Sub ' + + ' + ' + ''' + ''' Compares two items of type . + ''' + ''' The type of items to compare. + ''' The first item of type . + ''' The second item of type . + ''' True if the items are equal, False otherwise. + Public Function CompareItems(Of T As IComparable)(ByVal item1 As T, ByVal item2 As T) As Boolean + Return item1.CompareTo(item2) = 0 + End Function + ' End Class ' 925e5342-be05-45f2-bf66-7398bbd6710e.xml From 851eaf3379761f4e2cf043daa890ea72d9943cd7 Mon Sep 17 00:00:00 2001 From: Bill Wagner Date: Tue, 9 Sep 2025 11:11:15 -0400 Subject: [PATCH 3/9] Apply suggestions from code review --- .../language-reference/xmldoc/typeparamref.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/visual-basic/language-reference/xmldoc/typeparamref.md b/docs/visual-basic/language-reference/xmldoc/typeparamref.md index e6c886b452cb8..063053ce49151 100644 --- a/docs/visual-basic/language-reference/xmldoc/typeparamref.md +++ b/docs/visual-basic/language-reference/xmldoc/typeparamref.md @@ -1,11 +1,11 @@ --- description: "Learn more about: (Visual Basic)" title: "" -ms.date: 07/20/2015 +ms.date: 09/10/2025 helpviewer_keywords: - "typeparamref XML tag" - " XML tag" -ms.assetid: 8979d53b-beb1-41b7-b41e-6bbea1c17a03 +ai-usage: ai-assisted --- # \ (Visual Basic) @@ -19,8 +19,7 @@ Formats a word as a type parameter. ## Parameters - `name` - The name of the type parameter to refer to. Enclose the name in double quotation marks (" "). + `name`: The name of the type parameter to refer to. Enclose the name in double quotation marks (" "). ## Remarks @@ -32,7 +31,7 @@ Formats a word as a type parameter. This example uses the `` tag to refer to the `T` type parameter. - [!code-vb[VbVbcnXmlDocComments#9](~/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/Class1.vb#9)] +:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/Class1.vb id="snippet9"::: ## See also From 40f4a96459016fe3daf245ddc20714930aa9f5d3 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 9 Sep 2025 15:17:03 +0000 Subject: [PATCH 4/9] Add typeparamref to TOC and create VB project file for CI Co-authored-by: BillWagner <493969+BillWagner@users.noreply.github.com> --- docs/visual-basic/toc.yml | 2 ++ .../VB/VbVbcnXmlDocComments.vbproj | 10 ++++++++++ 2 files changed, 12 insertions(+) create mode 100644 samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj diff --git a/docs/visual-basic/toc.yml b/docs/visual-basic/toc.yml index 0e749ebb57c55..0aa0aa2e05b2d 100644 --- a/docs/visual-basic/toc.yml +++ b/docs/visual-basic/toc.yml @@ -852,6 +852,8 @@ items: href: language-reference/xmldoc/summary.md - name: href: language-reference/xmldoc/typeparam.md + - name: + href: language-reference/xmldoc/typeparamref.md - name: href: language-reference/xmldoc/value.md - name: XML Axis Properties diff --git a/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj b/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj new file mode 100644 index 0000000000000..d400890c0104a --- /dev/null +++ b/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj @@ -0,0 +1,10 @@ + + + + Exe + net8.0 + VbVbcnXmlDocComments + true + + + \ No newline at end of file From 6f22986502632caafc70fa0b77b1ef634541097e Mon Sep 17 00:00:00 2001 From: Bill Wagner Date: Tue, 9 Sep 2025 11:26:46 -0400 Subject: [PATCH 5/9] Apply suggestions from code review --- docs/visual-basic/language-reference/xmldoc/typeparamref.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/visual-basic/language-reference/xmldoc/typeparamref.md b/docs/visual-basic/language-reference/xmldoc/typeparamref.md index 063053ce49151..535d90776823b 100644 --- a/docs/visual-basic/language-reference/xmldoc/typeparamref.md +++ b/docs/visual-basic/language-reference/xmldoc/typeparamref.md @@ -31,7 +31,7 @@ Formats a word as a type parameter. This example uses the `` tag to refer to the `T` type parameter. -:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/Class1.vb id="snippet9"::: +:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/Class1.vb" id="snippet9"::: ## See also From df8c069397d86a76a31a3a23f3df30d7ab2ec80a Mon Sep 17 00:00:00 2001 From: Bill Wagner Date: Tue, 9 Sep 2025 11:26:57 -0400 Subject: [PATCH 6/9] Apply suggestions from code review --- .../VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj b/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj index d400890c0104a..de89017de8f29 100644 --- a/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj +++ b/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj @@ -2,7 +2,7 @@ Exe - net8.0 + net9.0 VbVbcnXmlDocComments true From 0fe5eadba49feba683c6a39db6acadc24b301ea8 Mon Sep 17 00:00:00 2001 From: Bill Wagner Date: Tue, 9 Sep 2025 11:39:04 -0400 Subject: [PATCH 7/9] Apply suggestions from code review --- .../VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj b/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj index de89017de8f29..cf1e623175c70 100644 --- a/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj +++ b/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj @@ -1,7 +1,7 @@ - Exe + classlib net9.0 VbVbcnXmlDocComments true From 47c1cd439a1e4c31e9619b3eb3f473aef04d44e1 Mon Sep 17 00:00:00 2001 From: Bill Wagner Date: Tue, 9 Sep 2025 11:44:40 -0400 Subject: [PATCH 8/9] Update samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj --- .../VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj | 1 - 1 file changed, 1 deletion(-) diff --git a/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj b/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj index cf1e623175c70..6c01204549952 100644 --- a/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj +++ b/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj @@ -1,7 +1,6 @@ - classlib net9.0 VbVbcnXmlDocComments true From 254bdeaa0ba079b7d801c8ef00b479e44bcf3e56 Mon Sep 17 00:00:00 2001 From: Bill Wagner Date: Tue, 9 Sep 2025 15:04:11 -0400 Subject: [PATCH 9/9] Update docs/visual-basic/language-reference/xmldoc/typeparamref.md Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- docs/visual-basic/language-reference/xmldoc/typeparamref.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/visual-basic/language-reference/xmldoc/typeparamref.md b/docs/visual-basic/language-reference/xmldoc/typeparamref.md index 535d90776823b..a85dae50fe407 100644 --- a/docs/visual-basic/language-reference/xmldoc/typeparamref.md +++ b/docs/visual-basic/language-reference/xmldoc/typeparamref.md @@ -29,7 +29,7 @@ Formats a word as a type parameter. ## Example - This example uses the `` tag to refer to the `T` type parameter. +This example uses the `` tag to refer to the `T` type parameter. :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/Class1.vb" id="snippet9":::