Ensure consistent formatting in JSDoc deprecation comments to improve API documentation clarity and developer experience. Use backticks around parameter/property names to distinguish them from regular text, use angle brackets for component names, and include “instead” for replacement suggestions.
Format Guidelines:
parameterName
<ComponentName />
Examples:
// ✅ Good
/** @deprecated Please use `orientation` instead */
direction?: 'horizontal' | 'vertical';
/** @deprecated Please use `railColor` instead */
trailColor?: string;
// For components
warning.deprecated(
true,
'<Statistic.Countdown />',
'<Statistic.Timer type="countdown" />',
);
// ❌ Bad
/** @deprecated please use orientation */
/** @deprecated Please use trailColor instead */
/** @deprecated Please use `tabsPlacement` instead */ // Wrong parameter name
This standardization helps developers quickly identify deprecated APIs and their replacements, improving the overall API migration experience.
Enter the URL of a public GitHub repository