扩展jsDoc以处理自定义标记

时间:2015-05-11 05:42:38

标签: node.js documentation-generation jsdoc3

我正在寻求扩展jsdoc(尤其是使用docstrap)。我有一个nodeJS应用程序,并希望将jsdoc导航分为Controllers,Views等。 我已经通过创建自定义标记(例如@controller)在一定程度上管理了这一点,并设法让它被JsDoc捕获,类似于@module,因此它会生成页面(包含说明) )。然而,我的问题是涉及与例如控制器相关联的功能,这些功能位于& module.exports'功能。生成的文档基本上忽略了@controller文件中的任何其他函数。我怎样才能捕获这些功能。

下面是一个例子:

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

    }
}

1 个答案:

答案 0 :(得分:0)

在类似的上下文中对我有用的是使用插件,当标记为module时,该插件会有效地将元素标记为controller。这样,您就可以获得类似模块的行为,然后在渲染模块时,您只需排除模型,视图和控制器。

我必须修补很多地方才能让它工作,否则一些行为只会绑定到modules并且顶部没有抽象,这会让你触发相同的行为。