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

Lines in a multiline comment should start with "*"

    XMLWordPrintable

    Details

    • Type: Code Smell Detection
    • Status: Active
    • Resolution: Unresolved
    • Labels:
    • Message:
      Start the lines in this comment block with "*".
    • Default Severity:
      Minor
    • Impact:
      Low
    • Likelihood:
      Low
    • Legacy Key:
      MultiLineCommentFormatCheck
    • Covered Languages:
      PL/SQL
    • Remediation Function:
      Constant/Issue
    • Constant Cost:
      10min

      Description

      Multi-line comments are more readable when each line is aligned using the "*" character. At most one violation is created for each comment

      Noncompliant Code Example

      /*
      this line is not aligned and ugly Non-Compliant
      no violation is created on this line, even though is it also bad
       */
      
      /* this is Compliant */
      

      Compliant Solution

      /*
       * this is much better Compliant
       */
      
      /* this is Compliant */
      

        Attachments

          Issue Links

            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: