定位SDK文档

文档的生成，使用标准TypeDoc生成

https://code.alibaba-inc.com/amaplbs_sdk/harmony_loc_doc

准备

由于标准的ts和鸿蒙的ets有兼容性问题，目前使用原生ts无法编译通过鸿蒙的代码， 只能使用比较low的方法生成文档。后续再调用标准的编译流程

step1

将需要生成的ets的文件拷贝到工程中，配置好package.json,tsconfig.json

step2

批量修改文件转成ets转成ts

find . -name "*.ets" -exec sh -c 'mv "$0" "${0%.ets}.ts"' {} \;
Copy

step3

因为文档的生成依赖tsc的编译，所以需要处理代码达到能编译通过的状态。使工程能够生成抽象语法树，进而TypeDoc可以解析语法树抽离注释生成文档。可以手动注释掉异常的代码。确保方法和类的注释能正常生成。

生成

git clone git@gitlab.alibaba-inc.com:amaplbs_sdk/harmony_loc_doc.git
npm install

# 生成文档
npm run docs
Copy