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.
77 lines
1.2 KiB
Plaintext
77 lines
1.2 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Marking a variable that is unchanged after initialization ``++const++`` is an indication to future maintainers that "no this isn't updated, and it's not supposed to be". ``++const++`` should be used in these situations in the interests of code clarity.
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,csharp]
|
|
----
|
|
public bool Seek(int[] input)
|
|
{
|
|
var target = 32; // Noncompliant
|
|
foreach (int i in input)
|
|
{
|
|
if (i == target)
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
----
|
|
or
|
|
|
|
[source,csharp]
|
|
----
|
|
public class Sample
|
|
{
|
|
public void Method()
|
|
{
|
|
var context = $"{nameof(Sample)}.{nameof(Method)}"; // Noncompliant (C# 10 and above only)
|
|
}
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,csharp]
|
|
----
|
|
public bool Seek(int[] input)
|
|
{
|
|
const int target = 32;
|
|
foreach (int i in input)
|
|
{
|
|
if (i == target)
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
----
|
|
or
|
|
|
|
[source,csharp]
|
|
----
|
|
public class Sample
|
|
{
|
|
public void Method()
|
|
{
|
|
const string context = $"{nameof(Sample)}.{nameof(Method)}";
|
|
}
|
|
}
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Add the 'const' modifier to 'xxx'.
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|