Comments in code

• “Add comments to modules and exported functions to give other developers a leg up when they come to use it.” ¹
• Restrict non-API commenting
• Add comments to document elusive bits of a project that can’t be documented anywhere else: ¹
  • Engineering tradeoffs
  • why decisions were made
  • what other alternatives were discarded
  • etc.

References