Javascript 防止jsdoc输出中的全局变量
我目前正在用jsdoc记录我的JS文件,但我遇到了一些麻烦。我有两个文件,Javascript 防止jsdoc输出中的全局变量,javascript,jsdoc,Javascript,Jsdoc,我目前正在用jsdoc记录我的JS文件,但我遇到了一些麻烦。我有两个文件,file1.js和file2.js(显然不是他们的真名)。这两个文件都包含我用jsdoc风格记录的许多函数。当我同时在两个文件上运行jsdoc时,输出是一个全局函数列表及其描述。函数的实际位置之间没有区别(可以是file1.js或file2.js)。我有没有办法创建这种区别,以便使我的文档具有更好的结构?您可以在每个文件中使用@module标记: /** * @module file1 */ 您将对其他文件使用fil
file1.js
和file2.js
(显然不是他们的真名)。这两个文件都包含我用jsdoc风格记录的许多函数。当我同时在两个文件上运行jsdoc时,输出是一个全局函数列表及其描述。函数的实际位置之间没有区别(可以是file1.js
或file2.js
)。我有没有办法创建这种区别,以便使我的文档具有更好的结构?您可以在每个文件中使用@module
标记:
/**
* @module file1
*/
您将对其他文件使用file2
。我假设您的模块与您的文件具有相同的名称
然后,当您想要引用模块中的内容时,可以使用模块:
符号。因此,如果file1
模块包含名为foo
的类。您可以参考它来注意另一个模块中的函数返回的数据类型,返回值为@returns{module:file1~foo}
。解释了波浪形符号。它只是表示foo
是模块file1
的“内部”成员。(在我看来,将其设置为“静态”成员会更好,但当前版本的jsdoc无法很好地处理模块。)