diff --git a/docs/fundamentals/code-analysis/quality-rules/ca1727.md b/docs/fundamentals/code-analysis/quality-rules/ca1727.md index 7b8bd54b77779..5a56ec4d59c9e 100644 --- a/docs/fundamentals/code-analysis/quality-rules/ca1727.md +++ b/docs/fundamentals/code-analysis/quality-rules/ca1727.md @@ -9,6 +9,8 @@ helpviewer_keywords: - CA1727 - LoggerMessageDefineAnalyzer author: Youssef1313 +dev_langs: +- CSharp --- # CA1727: Use PascalCase for named placeholders @@ -32,6 +34,10 @@ A named placeholder used with should Use PascalCase for named placeholders. For example, change `{firstName}` to `{FirstName}`. +## Example + +:::code language="csharp" source="snippets/csharp/all-rules/ca1727.cs" id="snippet1"::: + ## When to suppress warnings It is safe to suppress a warning from this rule. diff --git a/docs/fundamentals/code-analysis/quality-rules/snippets/csharp/all-rules/ca1727.cs b/docs/fundamentals/code-analysis/quality-rules/snippets/csharp/all-rules/ca1727.cs new file mode 100644 index 0000000000000..45666b3429214 --- /dev/null +++ b/docs/fundamentals/code-analysis/quality-rules/snippets/csharp/all-rules/ca1727.cs @@ -0,0 +1,25 @@ +using Microsoft.Extensions.Logging; + +namespace ca1727 +{ + // + public class UserService + { + private readonly ILogger _logger; + + public UserService(ILogger logger) + { + _logger = logger; + } + + public void Create(string firstName, string lastName) + { + // This code violates the rule. + _logger.LogInformation("Creating user {firstName} {lastName}", firstName, lastName); + + // This code satisfies the rule. + _logger.LogInformation("Creating user {FirstName} {LastName}", firstName, lastName); + } + } + // +}