Last updated Unknown

Status: Tags: Links: Code Commenting Practices

Documenting Functions

Principles

• Use the right documenting syntax for the appropriate language
  • ex) JSDoc for JS: @param {number} x The user's height
• Explain why you chose the methodology to prevent incorrect future improvements

References:

Created:: 2021-05-28 18:16 PM