Dashboardclipackages/cli JSDoc field contracts

packages/cli JSDoc field contracts

Category: preference
Confidence: 1.00
ID: 01a08348-71e7-7ed0-99c3-30f5b17c7366
Project ID: c760f4f9-42b0-4ce0-b36d-6b8c38d770b2
Cross-project: No
Recalled in other projects: 0
Source session: 1Y3CCMeLLwbVclKR7
Created: 2026-08-21 22:40:24
Updated: 2026-09-08 23:09:18

Content

Prefer JSDoc to inline comments. In packages/cli, add JSDoc to exported functions, classes, and types, plus important internal symbols. Document every type or interface property’s representation, units, permitted values, null meaning, and defaults; TypeScript syntax alone does not explain runtime units, sentinel values, or default behavior.

Move to: