是指在使用jsDoc生成文档时,排除掉不需要包含在文档中的外部变量。这可以通过在jsDoc注释中使用特定的标记来实现。
在jsDoc注释中,可以使用@ignore
标记来排除特定的变量。例如,如果要排除名为externalVariable
的外部变量,可以在注释中添加@ignore
标记:
/**
* @ignore
*/
var externalVariable;
这样,在生成文档时,externalVariable
将被排除在外,不会包含在文档中。
另外,如果要排除整个外部模块或文件中的变量,可以使用@module
或@file
标记,并将其设置为@ignore
。例如:
/**
* @module
* @ignore
*/
这将排除整个模块或文件中的所有变量。
需要注意的是,具体的jsDoc语法和标记可能因不同的工具和版本而有所差异。因此,在使用特定工具生成文档时,建议查阅该工具的文档以了解更详细的用法和配置选项。
对于腾讯云相关产品和产品介绍链接地址,可以参考腾讯云官方文档或开发者社区,以获取与云计算相关的产品信息和推荐链接。
领取专属 10元无门槛券
手把手带您无忧上云