Add missing typeparamref XML documentation tag for Visual Basic #48298
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dotnet-policy-service
bot
added
the
okr-quality
Co-authored-by: BillWagner <[email protected]>
Copilot
AI
changed the title
Copilot finished work on behalf of
BillWagner
September 8, 2025 18:43
BillWagner
reviewed
Sep 9, 2025
samples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/Class1.vb
Show resolved
Hide resolved
|
@copilot address remaining comments. |
Co-authored-by: BillWagner <[email protected]>
Copilot finished work on behalf of
BillWagner
September 9, 2025 15:18
BillWagner
reviewed
Sep 9, 2025
...nippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj
Outdated
Show resolved
Hide resolved
BillWagner
reviewed
Sep 9, 2025
BillWagner
reviewed
Sep 9, 2025
...nippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj
Outdated
Show resolved
Hide resolved
BillWagner
reviewed
Sep 9, 2025
...nippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/VbVbcnXmlDocComments.vbproj
Outdated
Show resolved
Hide resolved
…Comments/VB/VbVbcnXmlDocComments.vbproj
BillWagner
approved these changes
Sep 9, 2025
gewarren
approved these changes
Sep 9, 2025
Co-authored-by: Genevieve Warren <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
<typeparamref>XML documentation tag was missing from the Visual Basic documentation, even though it was documented for C#. This tag allows developers to reference type parameters in XML documentation comments with special formatting.Changes Made
docs/visual-basic/language-reference/xmldoc/typeparamref.md- Complete documentation for the<typeparamref>XML tag including syntax, parameters, remarks, and exampledocs/visual-basic/language-reference/xmldoc/index.md- Addedtypeparamrefto the list of recommended XML tagssamples/snippets/visualbasic/VS_Snippets_VBCSharp/VbVbcnXmlDocComments/VB/Class1.vbdemonstrating proper usagetypeparamref.mdto Visual Basic TOC for proper navigationVbVbcnXmlDocComments.vbproj) for CI build complianceDocumentation Structure
The new documentation follows the same format as other VB XML documentation tags:
<typeparamref name="name"/>The
<typeparamref>tag is now properly listed in the index alongside<typeparam>, providing complete coverage of XML documentation tags for generic types and methods in Visual Basic.Fixes #26647.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.
Internal previews