@longzai-intelligence-oxlint/tsdoc-plugin
v0.2.30
Published
Longzai Intelligence oxlint TSDoc 规则插件
Maintainers
Readme
@longzai-intelligence-oxlint/tsdoc-plugin
Longzai Intelligence Oxlint 的 TSDoc 治理插件,守护文档注释规范。
简介
治理文档注释规范失范的问题:TSDoc 写法统一、遗留 JSDoc 写法与占位描述等在静态检查阶段拦截,防止注释规范漂移。
能力
- 禁用类:注释内代码、description 标签、多余 param、遗留 JSDoc 标签、占位描述
- 格式类:param 连字符格式、标签前空行、分隔符格式、TODO 格式
- 必备类:deprecated 替代说明、description、多行属性注释、param 及其描述、returns 及其描述、throws 及其类型、tsdoc、type param
- 统一注册为
@longzai-intelligence/tsdoc
