Merged
Conversation
IDE0073 is caused by setting file_header_template and having more lines in the header comment than specified in the template. SA1512 is caused by having an empty line between a single-line comment and following code.
github-actions
bot
added
controls
pomianowski
approved these changes
Jun 2, 2024
Member
|
Hey @drolevar, thank you for your contribution |
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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 parameter
file_header_templatein.editorconfigintroduces the check for the file header. However, if the header comment contains more lines than specified infile_header_template, the header is detected as incorrect.This triggers a very significant number of Roslyn analyzer warnings, which makes it hard to detect the real issues.
The solution is to split the header comment into two: the one specified in
file_header_templateand the rest.Sometimes as a result the second part triggers the SA1512 warning, so it has to be converted to a multi-line comment.
Pull request type
Please check the type of change your PR introduces: