Enhance BC30059 documentation with array initialization guidance for optional parameters #48258
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 4, 2025 19:41
BillWagner
approved these changes
Sep 5, 2025
gewarren
approved these changes
Sep 5, 2025
| @@ -20,9 +20,90 @@ A `Const` statement doesn't properly initialize a constant, or an array declarat | |||
| 1. If the declaration is a `Const` statement, check to make sure the constant is initialized with a literal, a previously declared constant, an enumeration member, or a combination of literals, constants, and enumeration members combined with operators. | |||
There was a problem hiding this comment.
These should be bullets instead of numbered list according to style rules.
| @@ -20,9 +20,90 @@ A `Const` statement doesn't properly initialize a constant, or an array declarat | |||
| 1. If the declaration is a `Const` statement, check to make sure the constant is initialized with a literal, a previously declared constant, an enumeration member, or a combination of literals, constants, and enumeration members combined with operators. | |||
|
|
|||
| 2. If the declaration specifies an array, check to see if a variable is being used to specify the number of elements. If so, replace the variable with a constant expression. | |||
|
|
|||
| 3. If you're trying to initialize an array as the default value for an optional parameter, use one of the alternative approaches described in the [Array initialization in optional parameters](#array-initialization-in-optional-parameters) section below. | |||
There was a problem hiding this comment.
Suggested change
| 3. If you're trying to initialize an array as the default value for an optional parameter, use one of the alternative approaches described in the [Array initialization in optional parameters](#array-initialization-in-optional-parameters) section below. | |
| 3. If you're trying to initialize an array as the default value for an optional parameter, use one of the alternative approaches described in the [Array initialization in optional parameters](#array-initialization-in-optional-parameters) section. |
Comment on lines
+39
to
+41
| ### Alternative solutions | ||
|
|
||
| #### Option 1: Use ParamArray instead of Optional |
There was a problem hiding this comment.
Suggested change
| ### Alternative solutions | |
| #### Option 1: Use ParamArray instead of Optional | |
| ### Solution 1: Use ParamArray instead of Optional |
There was a problem hiding this comment.
Since there's no text between the H3 and H4s, seems like it's better to skip the "Alternative solutions" heading altogether.
| MyFun(("name1", "value1"), ("name2", "value2")) | ||
| ``` | ||
|
|
||
| #### Option 2: Use Nothing as default and initialize in the method body |
There was a problem hiding this comment.
Suggested change
| #### Option 2: Use Nothing as default and initialize in the method body | |
| ### Solution 2: Use Nothing as default and initialize in the method body |
| MyFun({("name", "value")}) | ||
| ``` | ||
|
|
||
| #### Option 3: Provide an overload without the parameter |
There was a problem hiding this comment.
Suggested change
| #### Option 3: Provide an overload without the parameter | |
| ### Solution 3: Provide an overload without the parameter |
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 BC30059 error documentation was missing guidance for developers encountering this error when trying to initialize arrays as default values for optional parameters. This is a common scenario that wasn't adequately covered in the existing documentation.
Changes Made
Enhanced
docs/visual-basic/misc/bc30059.mdwith:ParamArrayinstead of optional parametersNothingand initializing in the method bodyProblem Addressed
The original issue showed code like this failing with BC30059:
The documentation now clearly explains why this fails (array initialization is not a constant expression) and provides multiple working alternatives that achieve the same goal.
Validation
Fixes #20882.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.
Internal previews