Create rule S6146: "Option Explicit" should be enabled #4582
Conversation
This file contains 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
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
sebastien-marichal
requested changes
Dec 18, 2024
rules/S6146/vb6/rule.adoc
Outdated
|
|
||
| ==== Noncompliant code example | ||
| === Noncompliant code example |
There was a problem hiding this comment.
Please follow the LaYC format: https://github.com/SonarSource/rspec/blob/master/docs/description.adoc#2-learn-as-you-code-rule-format
The file generated with the github action contains the correct format:
== Why is this an issue?
== How to fix it
You can add here a small sentence to give a short description of the fix to do.
=== Code examples
==== Noncompliant code example
==== Compliant solution
rules/S6146/vb6/rule.adoc
Outdated
Comment on lines
20
to
22
| Sub DoSomething(Parameter As String) | ||
| ' ... | ||
| End Sub |
There was a problem hiding this comment.
I think this can be excluded of the example, it does not bring value to the description IMO.
rules/S6146/vb6/rule.adoc
Outdated
| @@ -0,0 +1,42 @@ | |||
| == Why is this an issue? | |||
|
|
|||
| There are several compilations options available for Visual Basic source code and ``++Option Explicit++`` defines compiler behavior for implicit variable declarations. Not specifying ``++Option Explicit++`` will allow creating a variable by it's first usage. This behavior can lead to unexpected runtime errors due to typos in variable names. | |||
There was a problem hiding this comment.
Suggested change
| There are several compilations options available for Visual Basic source code and ``++Option Explicit++`` defines compiler behavior for implicit variable declarations. Not specifying ``++Option Explicit++`` will allow creating a variable by it's first usage. This behavior can lead to unexpected runtime errors due to typos in variable names. | |
| There are several compilations options available for Visual Basic source code and `Option Explicit` defines compiler behavior for implicit variable declarations. Not specifying `Option Explicit` will allow creating a variable by it's first usage. This behavior can lead to unexpected runtime errors due to typos in variable names. |
sebastien-marichal
changed the title
|
|
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.
You can preview this rule here (updated a few minutes after each push).
Implementation-Ticket: SONARVBSIX-344
Review
A dedicated reviewer checked the rule description successfully for: