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

Track instances of below-threshold comment line density

    Details

    • Type: Finding Detection
    • Status: Active
    • Resolution: Unresolved
    • Labels:
    • Message:
      X more comment lines need to be written to reach the minimum threshold of Y% comment density.
    • List of parameters:
      • key = minimumCommentDensity
      • description = The minimum required comment density.
      • default = 25.0
    • Default Severity:
      Minor
    • Impact:
      Low
    • Likelihood:
      Low
    • Legacy Key:
      InsufficientCommentDensity
    • Covered Languages:
      ABAP, C#, C, C++, Cobol, Flex, HTML, Java, JavaScript, Objective-C, PHP, PL/I, PL/SQL, Python, RPG, Swift, T-SQL, TypeScript, VB.Net, VB6, XML
    • Remediation Function:
      Linear
    • Linear Argument Description:
      per additional line required to meet minimum density
    • Linear Factor:
      2min
    • Analysis Level:
      Syntactic Analysis
    • Analysis Scope:
      Main Sources
    • Common Rule:
      Yes
    • PMD:
      NcssTypeCount

      Description

      An issue is created on a file as soon as the density of comment lines on this file is less than the required threshold. The number of comment lines to be written in order to reach the required threshold is provided by each issue message.

        Attachments

          Issue Links

          is implemented by

          New Feature - A new feature of the product, which has yet to be developed. SONARRPG-7 Rule "Source files should have a sufficient density of comment lines"

          • Major - Major loss of function.
          • Closed

          Task - A task that needs to be done. CPP-707 Create Objective-C rules repository containing targeted rules

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. SONARABAP-206 Integrate the two rules "Insufficient comment density" and "Duplicated blocks should be removed "

          • Major - Major loss of function.
          • Closed
          relates to

          Improvement - An improvement or enhancement to an existing feature or task. SSLRSQBR-59 Update default severity of InsufficientCommentDensity

          • Major - Major loss of function.
          • Closed

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                freddy.mallet Freddy Mallet (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated: