Welcome to OGeek Q&A Community for programmer and developer-Open, Learning and Share
Welcome To Ask or Share your Answers For Others

Categories

0 votes
233 views
in Technique[技术] by (71.8m points)

javascript - 如何使用JSDoc按文件名重新整理文档(How to regroup documentation by filename with JSDoc)

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

(function1index.js)


function2 is in database.js

(function2database.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创建的文档里面,是有可能拥有的文档function1my_service/index.js和的文件function2my_service/database.js ?)

What is the correct JSDoc tag to use ?

(使用正确的JSDoc标签是什么?)

  ask by Bibas translate from so

与恶龙缠斗过久,自身亦成为恶龙;凝视深渊过久,深渊将回以凝视…
Welcome To Ask or Share your Answers For Others

1 Reply

0 votes
by (71.8m points)
等待大神答复

与恶龙缠斗过久,自身亦成为恶龙;凝视深渊过久,深渊将回以凝视…
OGeek|极客中国-欢迎来到极客的世界,一个免费开放的程序员编程交流平台!开放,进步,分享!让技术改变生活,让极客改变未来! Welcome to OGeek Q&A Community for programmer and developer-Open, Learning and Share
Click Here to Ask a Question

...