我们正在使用JSDOC来记录面向客户端的SDK,我们很难让它识别我们的'枚举'(即常量).我们应该使用哪些标签让JSDOC在文档中提取它?这是一个示例:
/**
* @module Enum
*/
export namespace {
/**
* @enum WidgetType {string}
*/
Enum.WidgetType = {
/** Dashboard */
Dashboard: 'dashboard',
/** Form */
Form: 'entityeditform',
/** Report */
Report: 'report'
};
}
Run Code Online (Sandbox Code Playgroud)
以下是代码中使用"枚举"的方法:
app.widget({ id: 'account_entityform', type: Enum.WidgetType.Form }).add();
Run Code Online (Sandbox Code Playgroud)
我们如何用JSDOC记录这个?