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.

Sign up for GitHub

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

Jump to bottom

Bracing Rules #46

Open

amanda-mitchell opened this issue Feb 8, 2019 · 1 comment

Labels

Contributor

amanda-mitchell commented Feb 8, 2019

StyleCop does not appear to support our preferred rules, and a quick search did not turn up any analyzers that do.

Our main rule is

Omit optional braces around single line blocks.

However, it has some exceptions and nuances:

The emphasis is on single line, rather than single statement. If a statement is split onto multiple lines, it should be surrounded by braces.
If the control flow mechanism (if condition, using declaration, etc.) is split onto multiple lines, include braces.
If the statement is part of an if-else chain in which any of the blocks require braces, use braces on all of them. (this part is covered by SA1520)

The text was updated successfully, but these errors were encountered:

amanda-mitchell added the new analyzer label

Contributor Author

amanda-mitchell commented Feb 21, 2019

Update: Roslynator has some relevant rules.

https://github.com/JosefPihrt/Roslynator/blob/master/docs/analyzers/RCS1001.md
https://github.com/JosefPihrt/Roslynator/blob/master/docs/analyzers/RCS1003.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment