防止jsdoc输出中的全局变量

Question

我目前用jsdoc记录我的JS文件,但是我遇到了一些麻烦.我有2个文件,file1.js并file2.js(而不是他们的真实姓名很明显).这两个文件都包含许多我在jsdoc样式中记录的函数.当我同时在两个文件上运行jsdoc时,输出是一个全局函数列表及其描述.功能实际位于何处(无论是在file1.js还是file2.js)中没有区别.有没有什么方法可以创建这种区别,以便为我的文档提供更好的结构？

Answer 1

您可以@module在每个文件中使用该标记:

/**
 * @module file1
 */

你将file2用于你的其他文件.我假设你的模块与你的文件同名.

然后,当您想要引用模块中的内容时,使用module:表示法.因此,如果您的file1模块包含一个名为的类foo.您可以参考它来记录另一个模块中的函数返回的数据类型@returns {module:file1~foo}.这里解释了波浪符号.它只是表明它foo是模块的"内部"成员file1.(在我看来,使它成为一个"静态"成员会更好,但是当前版本的jsdoc并不能很好地处理模块.)