Skip to content

Latest commit

 

History

History
53 lines (40 loc) · 1.57 KB

SA1510.md

File metadata and controls

53 lines (40 loc) · 1.57 KB

SA1510

TypeName SA1510ChainedStatementBlocksMustNotBePrecededByBlankLine
CheckId SA1510
Category Layout Rules

Cause

Chained C# statements are separated by a blank line.

Rule description

To improve the readability of the code, StyleCop requires blank lines in certain situations, and prohibits blank lines in other situations. This results in a consistent visual pattern across the code, which can improve recognition and readability of unfamiliar code.

Some types of C# statements can only be used when chained to the bottom of another statement. Examples include catch and finally statements, which must always be chained to the bottom of a try-statement. Another example is an else-statement, which must always be chained to the bottom of an if-statement, or to another else-statement. These types of chained statements should not be separated by a blank line. For example:

try
{
    this.SomeMethod();
}

catch (Exception ex)
{
    Console.WriteLine(ex.ToString());
}

How to fix violations

To fix a violation of this rule, remove any blank lines between the chained statements.

How to suppress violations

[SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1510:ChainedStatementBlocksMustNotBePrecededByBlankLine", Justification = "Reviewed.")]
#pragma warning disable SA1510 // ChainedStatementBlocksMustNotBePrecededByBlankLine
#pragma warning restore SA1510 // ChainedStatementBlocksMustNotBePrecededByBlankLine