jsDoc

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

http://www.css88.com/doc/jsdoc/index.html

https://medium.com/@trukrs/type-safe-javascript-with-jsdoc-7a2a63209b76

@type

@param

@property

@returns

@this

@throws

@typedef

@constructor 标记类，构造函数，别名 @class

@classdesc 描述整个类

@extends 标记父类

@abstract 子类必须实现

@access <private|protected|public> 该成员访问级别，另可以 @private

@alias <aliasNamepath> 标记一个成员的别名

@author <name> [<emailAddress>]

@borrows <that namepath> as <this namepath> 这个对象使用另一个对象的某些东西

@callback 描述一个回调函数

@constant [<type> <name>] 记录一个常数，别名 @const，@default 标记默认值

@file @copyright 描述文件

@namespace 标记命名空间

@deprecated [<some text>] 启用方法

@desc 描述

@enum [<type>] 描述一个静态属性值的全部相同的集合

@event 描述一个事件

@fires 描述将出发一个事件

@examples 示例

@module

@exports <moduleName>

@function 标记为一个函数