Node.js 扩展jsDoc以处理自定义标记
我希望扩展jsdoc(特别是docstrap)。我有一个nodeJS应用程序,希望将jsdoc导航拆分为控制器、视图等。 我通过创建自定义标记(如Node.js 扩展jsDoc以处理自定义标记,node.js,documentation-generation,jsdoc3,Node.js,Documentation Generation,Jsdoc3,我希望扩展jsdoc(特别是docstrap)。我有一个nodeJS应用程序,希望将jsdoc导航拆分为控制器、视图等。 我通过创建自定义标记(如@controller)在一定程度上实现了这一点,并设法让它被JsDoc捕获,类似于@module,因此它生成了页面(带有说明)。然而,我的问题是当涉及到与“module.exports”功能相关联的功能时,例如控制器。生成的文档基本上忽略了@controller文件中的任何其他函数。如何捕获这些函数 下面是一个例子: /** * @controll
@controller
)在一定程度上实现了这一点,并设法让它被JsDoc捕获,类似于@module
,因此它生成了页面(带有说明)。然而,我的问题是当涉及到与“module.exports”功能相关联的功能时,例如控制器。生成的文档基本上忽略了@controller文件中的任何其他函数。如何捕获这些函数
下面是一个例子:
/**
* @controller my_controller
*/
module.exports = {
/**
* @description my function
*/
myFn : function(){
}
}
对于我来说,在类似的情况下,使用一个插件可以有效地将元素标记为
模块
,当它标记为控制器
时。通过这种方式,可以获得类似模块的行为,然后在渲染模块时,只需排除模型、视图和控制器
我必须在很多地方打补丁才能让它正常工作,因为有些行为只是绑定到
模块
,而且上面没有允许触发相同行为的抽象。到目前为止,我唯一能让它正常工作的方法是使用@memberof controller:my_controller
。还有其他选择吗?你能分享你的配置吗?