As a developer, I want to document the source code in a way that enhances its usability and reliability over time.
To ensure that all projects maintain high-quality and easy-to-understand code, it is important to follow these guidelines for documenting the source code:
-
Use JSDoc to document all classes. -
Use JSDoc to document all functions/methods except anonymous ones. -
Use line comments to clarify any code that may be difficult to understand.
Edited by Mats Lock