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

Multi-line comments should not be empty

    Details

    • Type: Code Smell Detection
    • Status: Active
    • Resolution: Unresolved
    • Labels:
      None
    • Message:
      Remove this comment, it is empty.
    • Default Severity:
      Minor
    • Impact:
      Low
    • Likelihood:
      Low
    • Default Quality Profiles:
      Sonar way
    • Targeted languages:
      ABAP, APEX, C#, C, C++, Cobol, Flex, HTML, Java, JavaScript, Objective-C, PHP, PL/I, PL/SQL, Python, RPG, Rust, Swift, T-SQL, TypeScript, VB.Net, VB6, XML
    • Covered Languages:
      CSS, Go, Kotlin, Ruby, Scala
    • Remediation Function:
      Constant/Issue
    • Constant Cost:
      1min
    • Analysis Level:
      Syntactic Analysis
    • Analysis Scope:
      Main Sources
    • Common Rule:
      Yes
    • Stylelint:
      comment-no-empty

      Description

      An empty multi-line comment is likely to be a mistake and doesn't help to improve the readability of the code. For these reasons, it should be removed.

      Noncompliant Code Example

      /* */
      
      /*
      
       */
      

        Attachments

          Issue Links

          1.
          Ruby RSPEC-4743 Language-Specification Active Unassigned

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                alexandre.gigleux Alexandre Gigleux
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated: