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.
50 lines
1.1 KiB
Plaintext
50 lines
1.1 KiB
Plaintext
== Why is this an issue?
|
|
|
|
The compiler automatically initializes class fields, auto-properties and events to their default values before setting them with any initialization values, so there is no need to explicitly set a member to its default value. Further, under the logic that cleaner code is better code, it's considered poor style to do so.
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,csharp]
|
|
----
|
|
class X
|
|
{
|
|
public int field = 0; // Noncompliant
|
|
public object o = null; // Noncompliant
|
|
public object MyProperty { get; set; } = null; // Noncompliant
|
|
public event EventHandler MyEvent = null; // Noncompliant
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,csharp]
|
|
----
|
|
class X
|
|
{
|
|
public int field;
|
|
public object o;
|
|
public object MyProperty { get; set; }
|
|
public event EventHandler MyEvent;
|
|
}
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
``++const++`` fields are ignored.
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|