Add example section to CA2017 documentation with C# and VB snippets

Co-authored-by: gewarren <[email protected]>

Author: Copilot

docs/fundamentals/code-analysis/quality-rules/ca2017.md

@@ -36,6 +36,14 @@ Match the number of placeholders in the template format with the number of passe
 
 Do not suppress a warning from this rule.
 
+## Example
+
+The following example shows methods that violate CA2017 and methods that satisfy the rule.
+
+:::code language="csharp" source="snippets/csharp/all-rules/ca2017.cs" id="snippet1":::
+
+:::code language="vb" source="snippets/vb/all-rules/ca2017-parameter-count-mismatch_1.vb":::
+
 ## See also
 
 - [Reliability rules](reliability-warnings.md)

docs/fundamentals/code-analysis/quality-rules/snippets/csharp/all-rules/all-rules.csproj

@@ -2,14 +2,15 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net9.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <Nullable>enable</Nullable>
     <RootNamespace>all_rules</RootNamespace>
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />
     <PackageReference Include="System.Data.SqlClient" Version="4.9.0" />
-    <PackageReference Include="System.Security.Permissions" Version="9.0.0" />
+    <PackageReference Include="System.Security.Permissions" Version="8.0.0" />
   </ItemGroup>
 
   <ItemGroup>

docs/fundamentals/code-analysis/quality-rules/snippets/csharp/all-rules/ca2017.cs

@@ -0,0 +1,37 @@
+using Microsoft.Extensions.Logging;
+
+namespace ca2017
+{
+    //<snippet1>
+    public class LoggingExample
+    {
+        private readonly ILogger<LoggingExample> _logger;
+
+        public LoggingExample(ILogger<LoggingExample> logger)
+        {
+            _logger = logger;
+        }
+
+        public void ExampleMethod()
+        {
+            string name = "Alice";
+            int age = 30;
+
+            // Violates CA2017: Too few arguments for placeholders
+            _logger.LogInformation("User {Name} is {Age} years old and lives in {City}", name, age);
+
+            // Violates CA2017: Too many arguments for placeholders  
+            _logger.LogError("Error occurred: {Message}", "Something went wrong", "Extra argument");
+
+            // Correct usage: Matching number of placeholders and arguments
+            _logger.LogInformation("User {Name} is {Age} years old", name, age);
+
+            // Correct usage: No placeholders, no arguments
+            _logger.LogInformation("Application started");
+
+            // Correct usage: Single placeholder, single argument
+            _logger.LogWarning("Failed to process {FileName}", "document.txt");
+        }
+    }
+    //</snippet1>
+}

docs/fundamentals/code-analysis/quality-rules/snippets/vb/all-rules/all-rules.vbproj

@@ -3,13 +3,14 @@
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <RootNamespace>all_rules</RootNamespace>
-    <TargetFramework>net9.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <NoWarn>$(NoWarn);SYSLIB0050</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />
     <PackageReference Include="System.Data.SqlClient" Version="4.9.0" />
-    <PackageReference Include="System.Security.Permissions" Version="9.0.0" />
+    <PackageReference Include="System.Security.Permissions" Version="8.0.0" />
   </ItemGroup>
 
 </Project>

docs/fundamentals/code-analysis/quality-rules/snippets/vb/all-rules/ca2017-parameter-count-mismatch_1.vb

@@ -0,0 +1,35 @@
+Imports Microsoft.Extensions.Logging
+
+Namespace ca2017
+
+    Public Class LoggingExample
+
+        Private ReadOnly _logger As ILogger(Of LoggingExample)
+
+        Public Sub New(logger As ILogger(Of LoggingExample))
+            _logger = logger
+        End Sub
+
+        Public Sub ExampleMethod()
+            Dim name As String = "Alice"
+            Dim age As Integer = 30
+
+            ' Violates CA2017: Too few arguments for placeholders
+            _logger.LogInformation("User {Name} is {Age} years old and lives in {City}", name, age)
+
+            ' Violates CA2017: Too many arguments for placeholders
+            _logger.LogError("Error occurred: {Message}", "Something went wrong", "Extra argument")
+
+            ' Correct usage: Matching number of placeholders and arguments
+            _logger.LogInformation("User {Name} is {Age} years old", name, age)
+
+            ' Correct usage: No placeholders, no arguments
+            _logger.LogInformation("Application started")
+
+            ' Correct usage: Single placeholder, single argument
+            _logger.LogWarning("Failed to process {FileName}", "document.txt")
+        End Sub
+
+    End Class
+
+End Namespace