rspec/rules/S818/java/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

55 lines
931 B
Plaintext

== Why is this an issue?
include::../description.adoc[]
=== Noncompliant code example
[source,java]
----
long long1 = 1l; // Noncompliant
float float1 = 1.0f; // Noncompliant
double double1 = 1.0d; // Noncompliant
----
=== Compliant solution
[source,java]
----
long long1 = 1L;
float float1 = 1.0F;
double double1 = 1.0D;
----
== Resources
* https://wiki.sei.cmu.edu/confluence/x/cdYxBQ[CERT DCL16-C.] - Use "L," not "l," to indicate a long value
* https://wiki.sei.cmu.edu/confluence/x/7DZGBQ[CERT, DCL50-J.] - Use visually distinct identifiers
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
=== Parameters
.checkOnlyLong
****
----
false
----
Set to "true" to ignore "float" and "double" declarations.
****
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]