我目前正在使用 jsdoc 记录我的 JS 文件，但遇到了一些麻烦。我有 2 个文件，file1.js 和 file2.js（显然不是他们的真名）。这两个文件都包含一些我以 jsdoc 样式记录的函数。当我同时在两个文件上运行 jsdoc 时，输出是一个全局函数列表及其描述。函数的实际位置没有区别（在file1.js 或file2.js 中）。有什么方法可以创建这种区别，以便为我的文档提供更好的结构？
【问题讨论】：
标签： javascript jsdoc
您可以在每个文件中使用@module 标签：
/**
* @module file1
*/
您可以将file2 用于您的其他文件。我假设您的模块与您的文件同名。
然后，当您想要引用模块中的内容时，您可以使用module: 表示法。所以如果你的file1 模块包含一个名为foo 的类。您可以参考它来注意另一个模块中的函数使用@returns {module:file1~foo} 返回的数据类型。 here 解释了波浪符号。它只是表明foo 是模块file1 的“内部”成员。 （在我看来，将其设为“静态”成员会更好，但当前版本的 jsdoc 不能很好地处理模块。）
【讨论】：