自動(dòng)生成文檔方案: TypeDoc 工具 (官方地址： https://typedoc.org/ )
選擇原因: RN的JS文件里有大量的ES6語(yǔ)法和JSX語(yǔ)法,TypeDoc對(duì)RN項(xiàng)目支持相對(duì)比較友好
-
TypeDoc 安裝步驟:
- 安裝方法a
npm install typedoc --save-dev針對(duì)自己的項(xiàng)目使用
安裝方法bnpm install typedoc --global全局可以使用該工具
- 支持RN需要在工程根目錄配置一個(gè)文件 tsconfig.json(文件放在附件里,具體參數(shù)參考該文件) 此為可選項(xiàng)，即是把命令行參數(shù)放到j(luò)son文件，省去在命令行里添加參數(shù)
- 生成文檔方式1: typedoc --out docs /src docs:生成的文件所在目錄 /src: 需要生成文檔的js文件目錄 命令中對(duì)應(yīng)的參數(shù)參考官方文檔 （沒(méi)有做 2 操作眨补，這是參數(shù)要在命令行里添加，具體參數(shù)參考官方文檔）
生成文檔方式2: typedoc --tsconfig tsconfig.json 這樣不需要在命令里加參數(shù),會(huì)去 tsconfig.json文件 加載設(shè)置參數(shù)（執(zhí)行了 2 操作赛惩，這樣會(huì)更方便一下） - 安裝方法a
具體目錄如下圖
20191025101406.jpg
tsconfig.json 文件內(nèi)部?jī)?nèi)容：
{
"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"
}
}
配置好以后，跳轉(zhuǎn)到項(xiàng)目目錄(此處即 TypeDocDemo ) 執(zhí)行第3步就會(huì)生成文檔啦，再附一張圖
20191025101759.jpg
出現(xiàn)如下圖log，表示生成文檔成功蝉娜，例子中的json配置，文檔會(huì)在當(dāng)前目錄創(chuàng)建一個(gè) docs 的文件夾
20191025102045.jpg
