Uploaded image for project: 'Moodle Community Sites'
  1. Moodle Community Sites
  2. MDLSITE-6616

Multiline inline comments are ugly.

XMLWordPrintable

    • Icon: Improvement Improvement
    • Resolution: Won't Do
    • Icon: Low Low
    • Coding style
    • None

      Policy

      The use of

      /* */
      

      for inline or multiline comments is not allowed.

      The existing coding style policy for comments remains unchanged.

      The coding standard (https://docs.moodle.org/dev/Coding_style#Inline_comments) mandates that a multiline inline comment must have each line starting with two forward slashes '//', this to me is 'ugly' and makes the comment harder to read - example attached.  Therefore I propose that '/* */' are allowed for 'multiline' comments (not single).

        1. Screenshot 2022-02-05 182130.png
          39 kB
          Gareth J Barnard
        2. Screenshot 2022-02-05 203632.png
          40 kB
          Gareth J Barnard

            Votes:
            1 Vote for this issue
            Watchers:
            13 Start watching this issue

              Created:
              Updated:
              Resolved:

                Error rendering 'clockify-timesheets-time-tracking-reports:timer-sidebar'. Please contact your Jira administrators.