From 321f63f70f5b317b079b2ac9de3c1db46bf9b97c Mon Sep 17 00:00:00 2001 From: yp9522 Date: Sat, 28 Jun 2025 17:41:47 +0800 Subject: [PATCH] =?UTF-8?q?arkOptions=E7=9B=B8=E5=85=B3=E6=A8=A1=E5=9D=97d?= =?UTF-8?q?oc=E6=89=AB=E6=8F=8F=E7=BB=93=E6=9E=9C=E6=95=B4=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: yp9522 --- .../arkts-utils/arkoptions-guide.md | 36 +++++++++---------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/zh-cn/application-dev/arkts-utils/arkoptions-guide.md b/zh-cn/application-dev/arkts-utils/arkoptions-guide.md index 7b30af773a2..03d4d0904b0 100644 --- a/zh-cn/application-dev/arkts-utils/arkoptions-guide.md +++ b/zh-cn/application-dev/arkts-utils/arkoptions-guide.md @@ -2,7 +2,7 @@ ## 概述 -arkOptions主要提供ArkTS编译相关配置，当前文档介绍arkOptions中types配置类型、maxFlowDepth配置控制流分析最大栈深度等，arkOptions中的其他配置项请参考[build-profile.json5](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/ide-hvigor-configuration-file-overview)。 +arkOptions提供ArkTS编译相关配置，包括types配置类型和maxFlowDepth配置控制流分析最大栈深度。更多配置项请参考[build-profile.json5](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/ide-hvigor-configuration-file-overview)。 ## types @@ -12,13 +12,13 @@ arkOptions主要提供ArkTS编译相关配置，当前文档介绍arkOptions中t | 属性名称 | 含义 | 配置范围 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | -------- | -| types | 通过types字段将指定的类型声明文件作为全局引入，从而避免在每个源码文件中单独引入。 | 模块级 | 数组 | 该标签可缺省，缺省值为空。 | +| types | types字段将指定的类型声明文件作为全局引入。 | 模块级 | 数组 | 该标签可缺省，缺省值为空。 | ### arkOptions中的types字段配置说明 arkOptions中types字段示例： -在模块build-profile.json5配置文件buildOption标签的arkOptions属性中添加types字段。 +在 `build-profile.json5` 配置文件的 `buildOption` 标签下的 `arkOptions` 属性中，添加 `types` 字段。 ```json // 在/entry/build-profile.json5 { @@ -28,14 +28,14 @@ arkOptions中types字段示例： } ``` -types字段支持填写包名、包所在位置的相对路径以及声明文件所在相对路径，仅支持当前模块内的查找，若目录下存在同名文件（后缀不同），默认加载顺序.d.ets > .d.ts。
+`types`字段支持填写包名、包所在位置的相对路径以及声明文件所在相对路径，仅支持当前模块内的查找。如果目录下存在同名文件（后缀不同），默认加载顺序为：.d.ets > .d.ts。 （1）填写包名方式：通过包名到oh_modules/@types/目录查找包名中定义的声明文件，如"chai"。
（2）填写包所在相对路径方式：支持在基于build-profile.json5的相对路径中查找定义的声明文件，如"./oh_modules/@types/mocha"。
（3）填写声明文件所在相对路径方式：支持查找相对路径下的声明文件，如"./src/main/ets/pages/global"。 ### 注意事项 -如果在types字段中填写包名或者包所在位置的相对路径，需要在工程文件/entry/oh-package.json5中dependencies作如下配置： +在types字段中填写包名或包所在位置的相对路径时，需在工程文件/entry/oh-package.json5的dependencies中进行如下配置： ```json "dependencies": { "@types/chai": "latest", @@ -43,14 +43,14 @@ types字段支持填写包名、包所在位置的相对路径以及声明文件 } ``` -如果在types字段中填写声明文件所在相对路径，前提是在模块下存在相应的声明文件，比如模块下存在src/main/ets/pages/global.d.ts声明文件，声明文件内容如下所示： +如果在 `types` 字段中填写声明文件的相对路径，前提是模块下存在相应的声明文件，例如 `src/main/ets/pages/global.d.ts`，声明文件内容如下所示： ```typescript declare namespace Global { type ObjectType = string | number; } ``` -通过types全局引入后，对全局类型的使用示例如下： +全局引入types后，使用全局类型的示例如下： ```typescript // 在entry/src/main/ets/pages/Index.ets let a: Chai.Message; @@ -66,12 +66,12 @@ let c: Global.ObjectType; | 属性名称 | 含义 | 配置范围 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | -------- | -| maxFlowDepth | 开发者通过maxFlowDepth字段自定义配置tsc编译过程中的tsc控制流分析最大栈，避免固定最大栈导致编译报栈问题。该配置项可配置的最小值为2000，可配置最大值为65535。 | 工程级 | 数字型 | 该标签可缺省，缺省值时使用tsc控制流分析最大栈默认值2000。 | +| maxFlowDepth | 开发者通过maxFlowDepth字段配置tsc编译过程中的控制流分析最大栈，避免编译报栈问题。配置项的最小值为2000，最大值为65535。 | 工程级 | 数字型 | 标签可缺省，缺省值为2000。 | ### arkOptions下的tscConfig中maxFlowDepth字段配置说明 arkOptions/tscConfig中maxFlowDepth字段展示。 -在工程级目录下的build-profile.json5配置文件buildOption标签的arkOptions/tscConfig属性中添加maxFlowDepth字段。 +在工程级目录下的build-profile.json5的buildOption标签中添加arkOptions/tscConfig属性的maxFlowDepth字段。 ```typescript // 在工程名/build-profile.json5文件中 @@ -84,8 +84,8 @@ arkOptions/tscConfig中maxFlowDepth字段展示。 ### 注意事项 -- 仅可在工程级目录下build-profile.json5文件中配置maxFlowDepth字段。 -- 若开发者未对maxFlowDepth字段进行配置时，则该字段默认为2000；若开发者对maxFlowDepth字段配置的值超过可配置范围，则会出现编译构建相关报错。 +- 仅可在工程级目录下的build-profile.json5文件中配置maxFlowDepth字段。 +- 若未配置maxFlowDepth字段，该字段默认值为2000；若配置值超出可配置范围，将出现编译构建错误。 ```txt hvigor ERROR: Schema validate failed. @@ -105,17 +105,17 @@ arkOptions/tscConfig中maxFlowDepth字段展示。 ### transformLib配置文件标签说明 -arkOptions的transformLib字段配置文件标签说明： +`arkOptions` 的 `transformLib` 字段用于配置文件标签。 | 属性名称 | 含义 | 配置范围 | 数据类型 | 是否可缺省 | | -------- | -------- | -------- | -------- | -------- | -| transformLib | 字节码插桩插件配置，允许开发者在编译时对字节码进行插桩修改。仅支持Stage模型，格式为相对路径，指向实现插桩功能的动态库。不同系统要求的动态库文件类型如下，动态库文件内容需要在对应平台生成，不能拷贝修改后缀名混用。| 模块级 | 字符串型 | 该标签可缺省，缺省值时代表不使用该功能。 | +| transformLib | 字节码插桩插件配置，允许在编译时对字节码进行插桩修改。仅支持Stage模型，格式为相对路径，指向实现插桩功能的动态库。不同系统要求的动态库文件类型如下：动态库文件内容需在对应平台生成，禁止跨平台使用。| 模块级 | 字符串型 | 该标签可缺省，缺省时代表不使用该功能。 | ### arkOptions中的transformLib字段配置说明 arkOptions中transformLib字段示例： -在模块build-profile.json5配置文件buildOption标签的arkOptions属性中添加transformLib字段。 +在build-profile.json5配置文件的buildOption标签下，于arkOptions属性中添加transformLib字段。 ```json // 在/entry/build-profile.json5 { @@ -127,10 +127,10 @@ arkOptions中transformLib字段示例： } ``` -修改方舟字节码能力可参考[编译期自定义修改方舟字节码](customize-bytecode-during-compilation.md)。 +修改方舟字节码能力，可参考[编译期自定义修改方舟字节码](customize-bytecode-during-compilation.md)。 ### 注意事项 -- 若开发者未对字段进行配置时，则默认不使用该功能。 -- HAP、HSP模块配置即生效，HAR模块仅字节码HAR配置生效，非字节码HAR配置不生效。 -- 文件格式要求：Windows：.dll文件，Linux/Mac：.so文件。 \ No newline at end of file +- 若未配置字段，则默认不使用该功能。。 +HAP 和 HSP 模块配置后立即生效，而 HAR 模块中仅字节码配置生效，非字节码配置则不生效。 +- 文件格式：Windows：.dll，Linux/Mac：.so。 \ No newline at end of file -- Gitee