51369b610e
When an include is not surrounded by empty lines, its content is inlined on the same line as the adjacent content. That can lead to broken tags and other display issues. This PR fixes all such includes and introduces a validation step that forbids introducing the same problem again.
68 lines
2.0 KiB
Plaintext
68 lines
2.0 KiB
Plaintext
== Why is this an issue?
|
|
|
|
When the line immediately after conditional statements has neither curly braces nor indentation, the intent of the code is unclear and perhaps not executed as expected.
|
|
Additionally, such code is confusing to maintainers.
|
|
|
|
The rule will check the line indentation after the following conditional statements:
|
|
|
|
* https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/statements/selection-statements#the-if-statement[if and if-else statements]
|
|
* https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/statements/iteration-statements#the-for-statement[for statement]
|
|
* https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/statements/iteration-statements#the-foreach-statement[foreach statement]
|
|
* https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/statements/iteration-statements#the-do-statement[do statement]
|
|
* https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/statements/iteration-statements#the-while-statement[while statement]
|
|
|
|
[source,csharp]
|
|
----
|
|
if (condition) // Noncompliant
|
|
DoTheThing();
|
|
DoTheOtherThing(); // Was the intent to call this function unconditionally?
|
|
----
|
|
|
|
It becomes even more confusing and bug-prone if lines get commented out.
|
|
|
|
[source,csharp]
|
|
----
|
|
if (condition) // Noncompliant
|
|
// DoTheThing();
|
|
DoTheOtherThing(); // Was the intent to call this function conditionally?
|
|
----
|
|
|
|
Indentation alone or together with curly braces makes the intent clear.
|
|
|
|
[source,csharp]
|
|
----
|
|
if (condition)
|
|
DoTheThing();
|
|
DoTheOtherThing(); // Clear intent to call this function unconditionally
|
|
|
|
// or
|
|
|
|
if (condition)
|
|
{
|
|
DoTheThing();
|
|
}
|
|
DoTheOtherThing(); // Clear intent to call this function unconditionally
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
=== Highlighting
|
|
|
|
* Primary: `if (condition)`
|
|
* Secondary: line of code following the condition
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|