在带有流类型注释的js上使用jsdoc

Question

当尝试使用流类型注释处理js源时，jsdoc解析器很难理解增强的语法！有没有办法在使用流类型注释增强的js源中使用jsdoc，或者从类型带注释的js生成文档的推荐方法是什么？

Answer 1

你可以使用带有strip-flow-types变换的babel并使用jsdoc-babel。

首先，您需要在jsdoc之上安装babel和相关软件包以及jsdoc-babel。然后，在根目录中创建一个包含以下内容的jsdoc-conf.json文件：

{
    "plugins": ["node_modules/jsdoc-babel"],
    "babel": {
        "presets": ["react"],
        "plugins": ["transform-react-jsx", "transform-flow-strip-types"]
    }
}

用法：jsdoc -c jsdoc-conf.json

您可以使用除了.babelrc文件之外应用的“babel”下jsdoc-babel的任何有效babel设置。例如预设ES2015或其他巴贝尔插件。希望这可以帮助！

Answer 2

刚开始使用documentation.js。支持JSdoc并开箱即用。