SONARJAVA-4327 Improve rule description, add Java exception (#1533)

SonarSource · Feb 6, 2023 · ff343a5 · ff343a5
1 parent d0ea589
commit ff343a5
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 14 deletions.
diff --git a/rules/S3937/compliant.adoc b/rules/S3937/compliant.adoc
@@ -0,0 +1,10 @@
+== Compliant Solution
+
+[source,text]
+----
+int thousand = 1000;
+int tenThousand = 10_000;
+int tenThousandWithout = 10000;
+int duos = 1_00_00;
+int million = 100_000_000;
+----
diff --git a/rules/S3937/csharp/rule.adoc b/rules/S3937/csharp/rule.adoc
@@ -1,5 +1,9 @@
 include::../rule.adoc[]
 
+include::../noncompliant.adoc[]
+
+include::../compliant.adoc[]
+
 ifdef::env-github,rspecator-view[]
 
 '''

diff --git a/rules/S3937/java/exceptions.adoc b/rules/S3937/java/exceptions.adoc
@@ -0,0 +1,9 @@
+== Exceptions
+
+No issue will be raised on binary numbers (starting with `0b` or `0B`). Binary number bits are often grouped corresponding to certain meanings, resulting in irregular bit group sizes.
+
+[source,java]
+----
+int configValue1 = 0b00_000_10_1; // Compliant
+int configValue2 = 0B00_000_10_1; // Compliant
+----
diff --git a/rules/S3937/java/rule.adoc b/rules/S3937/java/rule.adoc
@@ -1,5 +1,12 @@
 include::../rule.adoc[]
 
+include::../noncompliant.adoc[]
+
+include::../compliant.adoc[]
+
+include::exceptions.adoc[]
+
+
 ifdef::env-github,rspecator-view[]
 
 '''

diff --git a/rules/S3937/noncompliant.adoc b/rules/S3937/noncompliant.adoc
@@ -0,0 +1,8 @@
+== Noncompliant Code Example
+
+[source,text]
+----
+int thousand = 100_0
+int tenThousand = 100_00;
+int million = 1_000_00_000;
+----
diff --git a/rules/S3937/rule.adoc b/rules/S3937/rule.adoc
@@ -1,17 +1,4 @@
-The use of punctuation characters to separate subgroups in a number can make the number more readable. For instance consider 1,000,000,000 versus 1000000000. But when the grouping is irregular, such as 1,000,00,000; it indicates an error. 
+The use of punctuation characters to separate subgroups in a number can make the number more readable. For instance consider 1,000,000,000 versus 1000000000. But when the grouping is irregular, such as 1,000,00,000; it indicates an error.
 
 
 This rule raises an issue when underscores (``++_++``) are used to break a number into irregular subgroups.
-
-
-== Noncompliant Code Example
-
-[source,text]
-----
-int duos = 1_00_00; 
-int million = 1_000_00_000;  // Noncompliant
-int thousand = 1000;
-int tenThousand = 100_00;  // Noncompliant
-----
-
-