I'm currently writing some documentation on a big project and I am using JSDoc.
(我目前正在为一个大项目编写一些文档,并且正在使用JSDoc。)
For now, I have several modules that correspond to the several micro-services of my application, I regroup the documentation with a @module my_service
tag for each of the services.
(现在,我有几个与应用程序的几个微服务相对应的模块,我为每个服务用@module my_service
标记将文档重新@module my_service
。)
I'm looking for a way to class the different functions of my_service
by file, for example :
(我正在寻找一种通过文件对my_service
的不同功能进行my_service
的方法,例如:)
function1
is in index.js
(function1
在index.js
)
function2
is in database.js
(function2
在database.js
)
Inside the documentation created by JSDoc, is it possible to have the documentation of the function1
in my_service/index.js
and the documentation of the function2
in my_service/database.js
?
(通过JSDoc创建的文档里面,是有可能拥有的文档function1
在my_service/index.js
和的文件function2
在my_service/database.js
?)
What is the correct JSDoc tag to use ?
(使用正确的JSDoc标签是什么?)
ask by Bibas translate from so
与恶龙缠斗过久,自身亦成为恶龙;凝视深渊过久,深渊将回以凝视…