Metadata
- Source
- SJRK-269
- Type
- Improvement
- Priority
- Major
- Status
- Closed
- Resolution
- Fixed
- Assignee
- N/A
- Reporter
- Gregor Moss
- Created
2019-08-28T14:47:30.785-0400 - Updated
2020-07-14T01:50:45.332-0400 - Versions
- N/A
- Fixed Versions
- N/A
- Component
-
- Storytelling Tool Server
- Storytelling Tool UI
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.
Comments
-
Gregor Moss commented
2020-07-14T01:50:45.315-0400 This work was done as part of SJRK-321 review, but it was not mentioned in commit messages so it didn't close automatically on merge.