typedoc使用说明

依赖tsconfig.json的配置信息，用于生成文档

package.json

scripts:{
  "typedoc": "typedoc"
},
"devDependencies": {
  "typedoc": "^0.28.15"
}

typedoc.json

{
  "entryPoints": ["./node/**/*.{ts,tsx}", "./src/**/*.{ts,tsx}"],
  "exclude": ["*/__tests__/*.ts", "node/codeCommentTest/*.ts", "./node/index.ts", "./src/index.ts"],
  "out": "docs",
  "name": "EasyUtilsSDK",
  "readme": "README.md",
  "theme": "default",
  "excludePrivate": true,
  "excludeProtected": true,
  "includeVersion": true,
  "disableSources": false,
}

其他说明

实践过程中为了更好的生成文档，做了如下调试：

• 调整"entryPoints": ["./node/**/*.{ts,tsx}", "./src/**/*.{ts,tsx}"],将所有的ts文件都产出文档。
• 以easyutilssdk/node/fs.ts为例，同时导出了nodeFsUtils以及具体方法，正常使用应该使用nodeFsUtils，具体方法导出是为了产出doc文档
• 以easyutilssdk/node/fs.ts为例，在头部声明@module用于生成doc文档

/**
 * @module fs
 * @description 文件系统工具模块，提供文件和文件夹操作的实用方法
 */