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