Skip to content

Latest commit

 

History

History
78 lines (60 loc) · 2.22 KB

SA1118.md

File metadata and controls

78 lines (60 loc) · 2.22 KB
Raw

SA1118

TypeName SA1118ParameterMustNotSpanMultipleLines
CheckId SA1118
Category Readability Rules

Cause

A parameter to a C# method or indexer, other than the first parameter, spans across multiple lines.

Rule description

To prevent method calls from becoming excessively complicated and unreadable, individual parameters and arguments should be placed on a single line. When parameters other than the first parameter span across multiple lines, it can be difficult to tell how many parameters are passed to the method. In general, the code becomes difficult to read. A violation of this rule is reported when a parameter or argument spans multiple lines, except in the following specific cases:

  • The first parameter may span multiple lines
  • Anonymous methods (including lambda expressions) may span multiple lines
  • Invocation expressions may span multiple lines
  • Object and array creation expressions may span multiple lines
  • with expressions (C# 9) may span multiple lines

For example, the following code would violate this rule, since the second parameter spans across multiple lines:

return JoinStrings(
    "John",
    "Smith" + 
    " Doe");

To fix the example above, ensure that the parameters after the first parameter do not span across multiple lines. If this will cause a parameter to be excessively long, store the value of the parameter within a temporary variable. For example:

string last = "Smith" + 
    " Doe";

return JoinStrings(
    "John",
    last);

In some cases, this will allow the method to be written even more concisely, such as:

return JoinStrings("John", last);

How to fix violations

To fix a violation of this rule, ensure that the parameters and arguments do not span multiple lines, except in the specific cases listed above.

How to suppress violations

[SuppressMessage("StyleCop.CSharp.ReadabilityRules", "SA1118:ParameterMustNotSpanMultipleLines", Justification = "Reviewed.")]
#pragma warning disable SA1118 // ParameterMustNotSpanMultipleLines
#pragma warning restore SA1118 // ParameterMustNotSpanMultipleLines