jsDoc

可以为 js 标记类型,也可以直接生成 API 文档。需要完善支持应该使用 typescript


@this
@throws
@typedef


@constructor 标记类,构造函数,别名 @class
@classdesc 描述整个类
@extends 标记父类
@abstract 子类必须实现
@access 该成员访问级别,另可以 @private
@alias 标记一个成员的别名
@author []
@borrows as 这个对象使用另一个对象的某些东西
@callback 描述一个回调函数
@constant [ ] 记录一个常数,别名 @const,@default 标记默认值
@file @copyright 描述文件
@namespace 标记命名空间
@deprecated [] 启用方法
@desc 描述
@enum [] 描述一个静态属性值的全部相同的集合
@event 描述一个事件
@fires 描述将出发一个事件
@examples 示例
@module
@exports
@function 标记为一个函数