Rule S1123: Add VB.NET (#1428)

SonarSource · Dec 5, 2022 · 95ab345 · 95ab345
1 parent f18ff13
commit 95ab345
Show file tree

Hide file tree

Showing 7 changed files with 65 additions and 14 deletions.
diff --git a/rules/S1123/comments-and-links.adoc b/rules/S1123/comments-and-links.adoc
@@ -1,3 +1,12 @@
+=== on 21 Jan 2015, 17:47:31 Nicolas Peru wrote:
+\[~ann.campbell.2] I don't think this is a relevant for java as we already have \http://jira.sonarsource.com/browse/RSPEC-1123
+
+=== on 22 Jan 2015, 07:41:48 Ann Campbell wrote:
+\[~nicolas.peru] does RSPEC-1123 set an issue when @Deprecated/@deprecated does not include explanatory text?
+
+=== on 11 May 2015, 09:20:36 Dinesh Bolkensteyn wrote:
+LGTM
+
 === on 18 Jul 2013, 07:31:52 Dinesh Bolkensteyn wrote:
 Implemented by \http://jira.codehaus.org/browse/SONARJAVA-214
 
diff --git a/rules/S1123/csharp/comments-and-links.adoc b/rules/S1123/csharp/comments-and-links.adoc
diff --git a/rules/S1123/csharp/rule.adoc b/rules/S1123/csharp/rule.adoc
@@ -1,4 +1,4 @@
-The ``++Obsolete++`` attribute can be applied with or without arguments, but marking something ``++Obsolete++`` without including advice as to why it's obsolete or on what to use instead will lead maintainers to waste time trying to figure those things out - every single time the warning is encountered.
+include::../description-dotnet.adoc[]
 
 == Noncompliant Code Example
 
@@ -8,7 +8,7 @@ public class Car
 {
 
   [Obsolete]  // Noncompliant
-  public void CrankEngine(int turnsOfCrank) 
+  public void CrankEngine(int turnsOfCrank)
   { ... }
 }
 ----
@@ -21,7 +21,7 @@ public class Car
 {
 
   [Obsolete("Replaced by the automatic starter")]
-  public void CrankEngine(int turnsOfCrank) 
+  public void CrankEngine(int turnsOfCrank)
   { ... }
 }
 ----
@@ -38,5 +38,5 @@ include::message.adoc[]
 == Comments And Links
 (visible only on this page)
 
-include::comments-and-links.adoc[]
+include::../comments-and-links.adoc[]
 endif::env-github,rspecator-view[]
diff --git a/rules/S1123/description-dotnet.adoc b/rules/S1123/description-dotnet.adoc
@@ -0,0 +1 @@
+The `Obsolete` attribute can be applied with or without a message argument. Marking something `Obsolete` without including advice on why it's obsolete or what to use instead will lead maintainers to waste time trying to figure those things out.
diff --git a/rules/S1123/vbnet/message.adoc b/rules/S1123/vbnet/message.adoc
@@ -0,0 +1,4 @@
+=== Message
+
+Add an explanation.
+
diff --git a/rules/S1123/vbnet/metadata.json b/rules/S1123/vbnet/metadata.json
@@ -0,0 +1,3 @@
+{
+  "title": "\"Obsolete\" attributes should include explanations"
+}
diff --git a/rules/S1123/vbnet/rule.adoc b/rules/S1123/vbnet/rule.adoc
@@ -0,0 +1,44 @@
+include::../description-dotnet.adoc[]
+
+== Noncompliant Code Example
+
+[source,vbnet]
+----
+Public Class Car
+
+    <Obsolete>  ' Noncompliant
+    Public Sub CrankEngine(Turns As Integer)
+        ' ...
+    End Sub
+
+End Class
+----
+
+== Compliant Solution
+
+[source,vbnet]
+----
+Public Class Car
+
+    <Obsolete("Replaced by the automatic starter")>
+    Public Sub CrankEngine(Turns As Integer)
+        ' ...
+    End Sub
+
+End Class
+----
+
+ifdef::env-github,rspecator-view[]
+
+'''
+== Implementation Specification
+(visible only on this page)
+
+include::message.adoc[]
+
+'''
+== Comments And Links
+(visible only on this page)
+
+include::../comments-and-links.adoc[]
+endif::env-github,rspecator-view[]