Uploaded image for project: 'Rules Repository'
  1. Rules Repository
  2. RSPEC-1712

Default parameters should not be defined

    XMLWordPrintable

    Details

    • Type: Code Smell Detection
    • Status: Active
    • Resolution: Unresolved
    • Labels:
      None
    • Message:
      Add an overloaded method to define [parameter name|parameter number n]
    • Default Severity:
      Major
    • Impact:
      Low
    • Likelihood:
      High
    • Covered Languages:
      C, C++
    • Remediation Function:
      Constant/Issue
    • Constant Cost:
      5min

      Description

      Setting method parameter defaults seems like a tidy way to make a method more usable. However, function pointers to methods with defaulted parameters can be confusing, because the function signature may not seem to match the call signature. Therefore, the use of multiple, overloaded methods is preferred.

      Noncompliant Code Example

      void HelloWorld (string name="World")
{
    cout << "Hello " << name << endl;
}

      Compliant Solution

      void HelloWorld (string name)
{
    cout << "Hello " << name << endl;
}

void HelloWorld ()
{
    HelloWorld("World");
}

      See also

      • S3719

        Attachments

          Issue Links

          is implemented by

          Improvement - An improvement or enhancement to an existing feature or task. CPP-606 Rule: Default parameters should not be defined

          • Major - Major loss of function.
          • Closed

          False-Positive - Unexpected issue reported by a rule CPP-2975 S1712: Do not raise on template instantiations

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Closed
          is related to

          False-Positive - Unexpected issue reported by a rule CPP-3014 S1712: Rework the rule to allow benign default arguments

          • Major - Major loss of function.
          • Open

          Code Smell Detection - RSPEC-3719 Virtual functions should not have default arguments

          • Active
          links to

          Web Link Google style guide on default arguments

            Activity

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              ann.campbell.2 Ann Campbell
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated: