Don't Repeat Type Information in Documentation

Overview

Type annotations are your documentation. Don't duplicate them in comments.

Comments describing types get out of sync with code. TypeScript's type system is designed to be compact and readable - use it as your primary source of type documentation.

When to Use This Skill

• Writing JSDoc or comments for functions
• Documenting parameter types
• Naming variables
• Describing return values

The Iron Rule