Uploaded image for project: 'Social Justice Repair Kit'
  1. Social Justice Repair Kit
  2. SJRK-269

Use JSDoc syntax for code comments

    XMLWordPrintable

    Details

      Description

      Use JSDoc syntax for the code comments throughout the project.

      According to the Laser Eye Checklist, the public API code should be commented. While this is broadly the case in the project already, using JSDoc can enable automatic generation of API documentation and take advantage of syntax highlighting in various IDEs & editors.

        Attachments

          Activity

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            gmoss Gregor Moss
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated: