rspec/rules/S1128/csharp/rule.adoc
Fred Tingaud 16f6c0aecf
Inline adoc when include has no additional value (#1940)
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.
2023-05-25 14:18:12 +02:00

74 lines
1.7 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

== Why is this an issue?
Although unnecessary ``++using++`` won't change anything to the produced application, removing them:
* Will help readability and maintenance.
* Will help reduce the number of items in the IDE auto-completion list when coding.
* May avoid some name collisions.
* May improve compilation time because the compiler has fewer namespaces to look-up when it resolves types.
* The build will fail if this namespace is removed from the project.
=== Noncompliant code example
[source,csharp]
----
using System.Collections.Generic; // Noncompliant - unnecessary using
namespace Foo
{
public class Bar
{
public Bar(string path)
{
File.ReadAllLines(path);
}
}
}
----
=== Compliant solution
[source,csharp]
----
using System.IO;
namespace Foo
{
public class Bar
{
public Bar(string path)
{
File.ReadAllLines(path);
}
}
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
* Remove this unused "using".
'''
== Comments And Links
(visible only on this page)
=== on 23 Sep 2019, 16:37:14 Nicolas Harraudeau wrote:
*OUT OF SCOPE*
Duplicate imports are out of scopes as Roslyn already raises an issue in this case. As Roslyn issues are enabled by default this would simply create duplicates.
=== on 18 Dec 2020, 10:06:15 Andrei Epure wrote:
We are removing this rule from SonarWay due to its performance issues. After the rule gets re-designed to avoid perf issues, (see https://github.com/SonarSource/sonar-dotnet/issues/3761[#3761]), we should bring it back to SonarWay.
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]