#
JavaScript
#
Coding Standards
- Remove any unused code, VSCode's ESLint extension is a useful tool for automating this process.
#
Code Commenting
See Coding Standards for general code commenting standards.
Entermedia follows the JSDoc 3 standard for inline JavaScript documentation.
#
What Should Be Documented
JavaScript documentation takes the form of either formatted blocks of documentation or inline comments.
The following is a list of what should be documented in JavaScript files:
- Functions and class methods
- Objects
- Closures
- Object properties
- Requires
- Events
- File headers