node.js - 扩展 jsDoc 以处理自定义标签

Question

我正在寻找扩展 jsdoc（尤其是 docstrap）。我有一个 nodeJS 应用程序，想将 jsdoc 导航拆分为控制器、视图等。通过创建我的自定义标签，我已经在一定程度上做到了这一点，@controller并设法让它被 JsDoc 捕获，类似于@module它生成页面（带有描述）。但是，我的问题是涉及与例如位于“module.exports”功能的控制器相关联的功能。生成的文档基本上忽略了该@controller 文件中的任何其他功能。我怎样才能捕获这些功能。

下面是一个例子：

/**
 * @controller my_controller
 */
module.exports = {
    /**
     * @description my function
     */
    myFn : function(){

    }
}

Answer 1

在类似的情况下对我有用的是使用一个插件，module当它被标记为时，它有效地将元素标记为controller. 这样你就可以得到类似模块的行为，然后在渲染模块时，你只需排除模型、视图和控制器。

我必须修补很多地方才能让它工作，否则因为某些行为只是绑定到modules并且顶部没有抽象可以让您触发相同的行为。