在Jsdoc上保留源代码文件夹结构可以通过配置jsdoc的--recurse
参数来实现。该参数会递归地处理指定文件夹下的所有文件,并保留文件夹结构。
以下是具体的步骤:
jsdoc.conf.json
的配置文件,并添加以下内容:jsdoc.conf.json
的配置文件,并添加以下内容:include
指定了源代码文件夹的路径,这里假设源代码文件夹为src
;exclude
指定了需要排除的文件夹,这里排除了node_modules
文件夹。destination
指定了生成文档的目标文件夹,这里设为docs
。src
文件夹下的所有文件,并将生成的文档保存在docs
文件夹中。通过以上步骤,你可以在生成的文档中保留源代码文件夹结构。这样,你可以更清晰地查看每个文件的文档,并按照文件夹结构进行组织和导航。
注意:以上步骤是基于Jsdoc的默认模板生成文档的。如果你想使用其他模板或自定义模板,可以在配置文件中进行相应的设置。
领取专属 10元无门槛券
手把手带您无忧上云