首页 > 解决方案 > 如何使用 JSDoc 按文件名重新组合文档

问题描述

我目前正在为一个大项目编写一些文档,并且正在使用 JSDoc。

现在,我有几个模块对应于我的应用程序的几个微服务,我用@module my_service每个服务的标签重新组合文档。

我正在寻找一种my_service按文件对不同功能进行分类的方法,例如:

function1index.js
function2里面database.js

在 JSDoc 创建的文档中,是否可以有in的文档和function1inmy_service/index.js的文档?function2my_service/database.js

要使用的正确 JSDoc 标记是什么?

标签: javascriptdocumentationjsdoc

解决方案


推荐阅读