如何将jsDoc与mobx-state-tree一起使用？

Question

我正在尝试将jsDoc用于由mobx-state-tree驱动的应用程序，但它没有按照我想要的方式进行响应。

Visual Studio代码没有显示相应类型的正确属性：

jsDoc在重构和保持js代码无错误时是一个巨大的帮助！但是在这种情况下如何使用呢？

我发现了这个，但是似乎没有任何人真正使用它：https://github.com/Feverqwe/mst-jsdoc-gen

我真的很奇怪其他开发人员如何处理这个问题！

Answer 1

您的项目可能缺少jsconfig.json或defines it to be a Javascript project to Visual Studio Code。

例如，给定的项目树

.
├── jsconfig.json
├── package-lock.json
├── package.json
├── src
│   ├── step.js
│   └── test.js
└── yarn.lock

在jsconfig.json中定义以下，

{
    "compilerOptions": {
      "module": "commonjs",
      "target": "es6"
    },
    "include": ["src/**/*"],
    "checkJs": true,
    "allowSyntheticDefaultImports": true
}

allowSyntheticDefaultImports配置很重要，因为它允许代码提示未在项目的Javascript模块中导出的符号。