-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Document enum zero conversion dangers and provide validation guidance #47737
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
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
Co-authored-by: BillWagner <[email protected]>
Copilot
AI
changed the title
[WIP] Potential dangers with enum
Document enum zero conversion dangers and provide validation guidance
Aug 5, 2025
Copilot finished work on behalf of
BillWagner
August 5, 2025 17:46
BillWagner
reviewed
Aug 6, 2025
Member
BillWagner
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a great start, but I have a few comments.
Member
|
@copilot address the review comments |
…recommendation Co-authored-by: BillWagner <[email protected]>
Contributor
Author
Copilot finished work on behalf of
BillWagner
August 6, 2025 18:19
BillWagner
approved these changes
Aug 6, 2025
Member
BillWagner
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is ready for final review.
adegeo
approved these changes
Aug 6, 2025
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.
This PR addresses a documentation gap regarding the implicit conversion behavior of zero values to enum types in C#. The current documentation briefly mentions that
(E)0is the default value even when zero doesn't have a corresponding enum member, but doesn't adequately warn developers about the potential risks.Problem
C# allows implicit conversions from the literal value
0andconstzero values to any enum type, even when the enum has no member with that value. This can lead to unexpected behavior:Solution
Added a new "Implicit conversions from zero" section that:
GpioPortenumEnum.IsDefined()to check for valid enum valuesEnum.IsDefined()for validation when converting from numeric typesThe code examples compile and run correctly, demonstrating both the problematic behavior and the safer validation approach.
Fixes #39809.
💡 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