• Home
• org.sonarsource.dotnet
• sonar-csharp-plugin
• 9.31.0.96804
• source code
• S3343.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.sonar.plugins.csharp.S3343.html Maven / Gradle / Ivy

Why is this an issue?
Caller information attributes
provide a way to get information about the caller of a method through optional
parameters. But they only work right if their values aren’t provided explicitly. So if you define a method with caller info attributes in the middle
of the parameter list, the caller is forced to use named arguments if they want to use the method properly.
This rule raises an issue when the following attributes are used on parameters before the end of the parameter list:

  
 CallerFilePathAttribute
  
  
 CallerLineNumberAttribute
  
  
 CallerMemberNameAttribute
  
  
 CallerArgumentExpressionAttribute 

How to fix it
Move the decorated parameters to the end of the parameter list.
Code examples
Noncompliant code example
void TraceMessage([CallerMemberName] string memberName = "",
  [CallerFilePath] string filePath = "",
  [CallerLineNumber] int lineNumber = 0,
  string message = null)  // Noncompliant: decorated parameters appear before "message" parameter
{
  /* ... */
}

Compliant solution
void TraceMessage(string message = null,
  [CallerMemberName] string memberName = "",
  [CallerFilePath] string filePath = "",
  [CallerLineNumber] int lineNumber = 0)
{
  /* ... */
}

Resources
Documentation

  
 Determine caller information using
  attributes interpreted by the C# compiler 
  
 CallerFilePathAttribute
  Class 
  
 CallerLineNumberAttribute
  Class 
  
 CallerMemberNameAttribute
  Class 
  
 CallerArgumentExpressionAttribute Class 
  
 Named
  and Optional Arguments