React Native 自动生成文档

自动生成文档方案: TypeDoc 工具 (官方地址： https://typedoc.org/ )
选择原因: RN的JS文件里有大量的ES6语法和JSX语法,TypeDoc对RN项目支持相对比较友好

2. TypeDoc 安装步骤:

   1. 安装方法a npm install typedoc --save-dev 针对自己的项目使用
      安装方法b npm install typedoc --global 全局可以使用该工具

   2. 支持RN需要在工程根目录配置一个文件 tsconfig.json(文件放在附件里,具体参数参考该文件) 此为可选项，即是把命令行参数放到json文件，省去在命令行里添加参数

   3. 生成文档方式1: typedoc --out docs /src docs:生成的文件所在目录 /src: 需要生成文档的js文件目录 命令中对应的参数参考官方文档 （没有做 2 操作，这是参数要在命令行里添加，具体参数参考官方文档）

    生成文档方式2:  typedoc --tsconfig tsconfig.json 这样不需要在命令里加参数,会去 tsconfig.json文件 加载设置参数（执行了 2 操作，这样会更方便一下）
   

具体目录如下图

20191025101406.jpg

tsconfig.json 文件内部内容：

{
    "compilerOptions": {
        "name":"RN文档",
        "allowJs": true,
        "module": "es2016",
        "target": "es6",
        "jsx": "react",
        "noEmit": true,
        "moduleResolution": "node",
        "importHelpers": true,
        "lib": ["es2015", "es2016"],
        "allowSyntheticDefaultImports": true
    },
    "include": [
        "src/**/*.js"
    ],
    "typedocOptions": {
        "ignoreCompilerErrors": true,
        "mode": "modules",
        "out": "./docs"
    }
}

配置好以后，跳转到项目目录(此处即 TypeDocDemo ) 执行第3步就会生成文档啦，再附一张图

20191025101759.jpg

出现如下图log，表示生成文档成功，例子中的json配置，文档会在当前目录创建一个 docs 的文件夹

20191025102045.jpg