【问题标题】:How to show warning when using functions incorrectly according to JSDoc?根据JSDoc错误使用函数时如何显示警告?
【发布时间】:2019-03-01 00:35:26
【问题描述】:
我正在使用 JSDoc 来记录我的 Javascript 函数并添加类型注释。
在 Visual Studio 中,我正在为这些功能获得智能感知,这很棒。但是,如果我使用了不正确的类型(例如,注释为字符串的参数的整数),我在任何地方都看不到任何关于它的警告。如果我为函数使用错误数量的参数,我也会遇到同样的问题。
我查看了“工具”>“选项”中的所有设置,但没有看到任何相关内容。我也使用 ReSharper,但在 R# 选项中也没有看到任何内容。
有没有办法让 Visual Studio 显示警告?
【问题讨论】:
标签:
javascript
visual-studio
visual-studio-2017
jsdoc
【解决方案1】:
您也可以在 Visual Studio Code 中执行此操作,方法是转到 Preferences > Settings 并检查 Javascript>Implicit Project Config-checkJs。
这应该为您提供一些基本的智能感知,并用熟悉的红色下划线标记类型错误。
【解决方案2】:
我找到了一个link 并提供了一些答案。有两种方法可以做到这一点:
- 通过将
tsconfig.json 添加到项目的根目录并使用“checkJs: true”为所有 Javascript 文件启用它
- 通过在文件开头添加
// @ts-check 为特定的 Javascript 文件启用它
然而,就我而言,我想在 Razor 文件中启用此功能,这些文件的底部都有一个 script 标记 - 但似乎类型检查只能在“纯”Javascript/Typescript 文件中进行。