JSDoc 在 vs code 已经内置了. 可以在 js 文件的开头添加 // @ts-check 即可.
在注释中标注来实现一些 ts 的功能.
JSDoc 支持以下注解.
Types
- @type
- @param (or @arg or @argument)
- @returns (or @return)
- @typedef
- @callback
- @template
Classes
- Property Modifiers @public, @private, @protected, @readonly
- @override
- @extends (or @augments)
- @implements
- @class (or @constructor)
- @this
Documentation
Documentation tags work in both TypeScript and JavaScript.
- @deprecated
- @see
- @link
Other
- @enum
- @author
官方文档
