16f6c0aecf
Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in.
62 lines
1.3 KiB
Plaintext
62 lines
1.3 KiB
Plaintext
== Why is this an issue?
|
|
|
|
``++GC.SuppressFinalize++`` asks the Common Language Runtime not to call the finalizer of an object. This is useful when implementing the dispose pattern where object finalization is already handled in ``++IDisposable.Dispose++``. However, it has no effect if there is no finalizer defined in the object's type, so using it in such cases is just confusing.
|
|
|
|
|
|
This rule raises an issue when ``++GC.SuppressFinalize++`` is called for objects of ``++sealed++`` types without a finalizer.
|
|
|
|
|
|
*Note:* S3971 is a stricter version of this rule. Typically it makes sense to activate only one of these 2 rules.
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,csharp]
|
|
----
|
|
sealed class MyClass
|
|
{
|
|
public void Method()
|
|
{
|
|
...
|
|
GC.SuppressFinalize(this); //Noncompliant
|
|
}
|
|
}
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,csharp]
|
|
----
|
|
sealed class MyClass
|
|
{
|
|
public void Method()
|
|
{
|
|
...
|
|
}
|
|
}
|
|
----
|
|
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Remove this useless call to "GC.SuppressFinalize".
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
=== is related to: S3971
|
|
|
|
=== on 7 Jul 2015, 08:43:00 Tamas Vajk wrote:
|
|
\[~ann.campbell.2] Created the first version, can you go through it? Also, I haven't set any SQALE characteristics. Which one fits best?
|
|
|
|
endif::env-github,rspecator-view[]
|