防止jsdoc输出中的全局变量

时间:2013-08-13 07:05:29

标签: javascript jsdoc

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

1 个答案:

答案 0 :(得分:5)

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

/**
 * @module file1
 */

您将file2用于其他文件。我假设你的模块与你的文件名称相同。

然后,当您想要引用模块中的内容时,使用module:表示法。因此,如果您的file1模块包含名为foo的类。您可以参考它来记录另一个模块中的函数返回@returns {module:file1~foo}的数据类型。道尔符号表示为here。它只是表明foo是模块file1的“内部”成员。 (在我看来,使它成为一个“静态”成员会更好,但当前版本的jsdoc并不适合模块。)