Angular / TypeScript Documentation Best Practices

When to Use

• Writing or reviewing TSDoc/JSDoc comments (/** ... */) on TypeScript types and members
• Adding documentation to the public API of a new or existing Angular library or shared module
• Documenting components, services, directives, pipes, and their input/output members (signal input()/output()/model() or @Input()/@Output())
• Reviewing missing, insufficient, or non-standard doc comments in TypeScript code
• Generating documentation that feeds Compodoc output or published library typings

General Guidelines

• Exported/public members of a library or shared API should be documented with TSDoc comments.
• It is encouraged to document non-exported members as well, especially if they are complex or not self-explanatory.
• Use the TSDoc comment form /** ... */ (not // line comments) so editors, the TypeScript language service, and Compodoc pick it up.

Guidance for all APIs