@longzai-intelligence-oxlint/tsdoc-plugin
v0.1.18
Published
Oxlint TSDoc 插件,提供 TSDoc 注释规范检查规则
Readme
@longzai-intelligence-oxlint/tsdoc-plugin
意图
在静态检查阶段守护 TSDoc 注释规范,统一组织内的文档注释写法并拦截遗留 JSDoc 写法。
定位
Oxlint 生态的 TSDoc 治理插件,规则数量较多,是组织内文档注释治理的核心载体。
职能
提供共二十条规则,覆盖:禁用注释内代码、禁用 description 标签、禁用多余 param、禁用遗留 JSDoc 标签、禁用占位描述、param 连字符格式、标签前空行、deprecated 必备替代说明、description 必备、多行属性注释必备、param 必备、param 描述必备、returns 必备、returns 描述必备、throws 必备、throws 类型必备、tsdoc 必备、type param 必备、分隔符格式、TODO 格式等;使用 defineRule + createOnce 实现以获得最佳性能。
实现情况
二十条规则均已实现并按规则文件组织,统一注册为 @longzai-intelligence/tsdoc;规则集合稳定且覆盖 TSDoc 主要规范维度。
