From 307f755ae86920892c7cd555d01b188d88d0bafd Mon Sep 17 00:00:00 2001 From: yuhaoqiang Date: Tue, 1 Jul 2025 19:12:37 +0800 Subject: [PATCH] =?UTF-8?q?hidebug=E6=96=87=E6=A1=A3=E4=BF=AE=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: yuhaoqiang (cherry picked from commit a7292856a9203a0b5dd0624ba261f73cdd3d6e88) Signed-off-by: yuhaoqiang (cherry picked from commit 272183cc312f4fc17f3a5c8f762b5b6a27d235ce) --- .../dfx/hidebug-guidelines-arkts.md | 8 ++++---- .../application-dev/dfx/hidebug-guidelines-ndk.md | 14 +++++++------- .../js-apis-hidebug.md | 6 +++--- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/zh-cn/application-dev/dfx/hidebug-guidelines-arkts.md b/zh-cn/application-dev/dfx/hidebug-guidelines-arkts.md index b17536508ff..63f0dccc924 100644 --- a/zh-cn/application-dev/dfx/hidebug-guidelines-arkts.md +++ b/zh-cn/application-dev/dfx/hidebug-guidelines-arkts.md @@ -1,6 +1,6 @@ # 使用HiDebug获取调试信息（ArkTS） -为应用提供多种调试和调优方法。包括但不限于内存、CPU、GPU、GC等相关数据的获取，进程trace、profiler采集，VM堆快照转储等。由于该模块的接口大多比较耗费性能，接口调用较为耗时，且基于HiDebug模块定义，该模块内的接口仅建议在应用调试，调优阶段使用。若需要在其他场景使用时，请认真评估所需调用的接口对应用性能的影响。 +为应用提供多种调试和调优方法。包括但不限于内存、CPU、GPU、GC等相关数据的获取，进程trace、profiler采集，VM堆快照转储等。由于该模块的接口大多比较耗费性能，接口调用较为耗时，且基于HiDebug模块定义，该模块内的接口仅建议在应用调试、调优阶段使用。若需要在其他场景使用时，请认真评估所需调用的接口对应用性能的影响。 ## 接口说明 @@ -27,8 +27,8 @@ | hidebug.setAppResourceLimit | 设置应用的fd数量、线程数量、js内存或者native内存资源限制。 | | hidebug.getAppNativeMemInfo | 获取应用进程内存信息。 | | hidebug.getSystemMemInfo | 获取系统内存信息。 | -| hidebug.getVMRuntimeStats | 获取系统gc全部统计信息。 | -| hidebug.getVMRuntimeStat | 根据参数获取指定的系统gc统计信息。 | +| hidebug.getVMRuntimeStats | 获取系统[GC](../arkts-utils/gc-introduction.md)统计信息。 | +| hidebug.getVMRuntimeStat | 根据参数获取指定的系统[GC](../arkts-utils/gc-introduction.md)统计信息。 | | hidebug.isDebugState | 获取应用进程被调试状态。 | | hidebug.getGraphicsMemory | 使用异步方式获取应用显存大小。 | | hidebug.getGraphicsMemorySync | 使用同步方式获取应用显存大小。 | @@ -77,7 +77,7 @@ HiDebug的具体用法可查看API参考[API参考文档](../reference/apis-perf Text(this.message) .fontSize(50) .fontWeight(FontWeight.Bold) - .onClick(testHiDebug);//添加点击事件 + .onClick(testHiDebug);// 添加点击事件 } .width('100%') } diff --git a/zh-cn/application-dev/dfx/hidebug-guidelines-ndk.md b/zh-cn/application-dev/dfx/hidebug-guidelines-ndk.md index ff713c1d8a0..e39e7db1368 100644 --- a/zh-cn/application-dev/dfx/hidebug-guidelines-ndk.md +++ b/zh-cn/application-dev/dfx/hidebug-guidelines-ndk.md @@ -1,6 +1,6 @@ # 使用HiDebug获取调试信息（C/C++） -本模块可用于应用进程的内存、CPU、GPU等相关数据的获取，开启进程trace采集等。由于该模块的接口大多比较耗费性能，接口调用较为耗时，且基于HiDebug模块定义，该模块内的接口仅建议在应用调试，调优阶段使用。若需要在其他场景使用时，请认真评估所需调用的接口对应用性能的影响。 +本模块可用于应用进程的内存、CPU、GPU等相关数据的获取，开启进程trace采集等。由于该模块的接口大多比较耗费性能，接口调用较为耗时，且基于HiDebug模块定义，该模块内的接口仅建议在应用调试、调优阶段使用。若需要在其他场景使用时，请认真评估所需调用的接口对应用性能的影响。 ## 接口说明 | 接口名 | 描述 | @@ -108,7 +108,7 @@ API接口的具体使用说明（参数使用限制、具体取值范围等） Text(this.message) .fontSize(50) .fontWeight(FontWeight.Bold) - .onClick(testNapi.testHiDebugNdk);//添加点击事件，触发testHiDebugNdk方法。 + .onClick(testNapi.testHiDebugNdk);// 添加点击事件，触发testHiDebugNdk方法。 } .width('100%') } @@ -154,7 +154,7 @@ API接口的具体使用说明（参数使用限制、具体取值范围等） void InitSignalHandle(); void BacktraceFrames(); - #endif //MYAPPLICATION_TESTBACKTRACE_H + #endif // MYAPPLICATION_TESTBACKTRACE_H ``` 3. 编辑“test_backtrace.cpp”文件如下： @@ -167,7 +167,7 @@ API接口的具体使用说明（参数使用限制、具体取值范围等） #include "hidebug/hidebug.h" #include "hilog/log.h" - #define MAX_FRAME_SIZE 256 //最大栈回溯深度，应根据业务场景调整该值。 + #define MAX_FRAME_SIZE 256 // 最大栈回溯深度，应根据业务场景调整该值。 namespace { constexpr auto LOG_PRINT_DOMAIN = 0xFF00; @@ -339,7 +339,7 @@ API接口的具体使用说明（参数使用限制、具体取值范围等） TestNativeFrames(i - 1); return; } - std::this_thread::sleep_for(std::chrono::seconds(3)); //模拟主线程阻塞。 + std::this_thread::sleep_for(std::chrono::seconds(3)); // 模拟主线程阻塞。 } __attribute((noinline)) __attribute((optnone)) napi_value TestHiDebugNdk(napi_env env, napi_callback_info info) @@ -400,7 +400,7 @@ API接口的具体使用说明（参数使用限制、具体取值范围等） .fontWeight(FontWeight.Bold) .onClick(() => { testJsFrame(3); - });//添加点击事件，触发testHiDebugNdk方法。 + });// 添加点击事件，触发testHiDebugNdk方法。 } .width('100%') } @@ -413,7 +413,7 @@ API接口的具体使用说明（参数使用限制、具体取值范围等） 9. 在DevEco Studio的底部，切换到“Log”窗口，设置日志的过滤条件为“TestTag”。 - 此时窗口将显示通过主线程当前调用栈的相关日志，由于回栈时基于LR寄存器（保存的函数返回地址），故无法获取到当前调用函数的栈信息。 + 此时窗口将显示主线程当前调用栈的相关日志，由于回栈时基于LR寄存器（保存的函数返回地址），故无法获取到当前调用函数的栈信息。 ```Text ... diff --git a/zh-cn/application-dev/reference/apis-performance-analysis-kit/js-apis-hidebug.md b/zh-cn/application-dev/reference/apis-performance-analysis-kit/js-apis-hidebug.md index 3d1857652b8..8c266222211 100644 --- a/zh-cn/application-dev/reference/apis-performance-analysis-kit/js-apis-hidebug.md +++ b/zh-cn/application-dev/reference/apis-performance-analysis-kit/js-apis-hidebug.md @@ -1,6 +1,6 @@ # @ohos.hidebug (Debug调试) -为应用提供多种以供调试、调优的方法。包括但不限于内存、CPU、GPU、GC等相关数据的获取，进程trace、profiler采集，VM堆快照转储等。由于该模块的接口大多比较耗费性能，接口调用较为耗时，且基于HiDebug模块定义，该模块内的接口仅建议在应用调试，调优阶段使用。若需要在其他场景使用时，请认真评估所需调用的接口对应用性能的影响。 +为应用提供多种以供调试、调优的方法。包括但不限于内存、CPU、GPU、GC等相关数据的获取，进程trace、profiler采集，VM堆快照转储等。由于该模块的接口大多比较耗费性能，接口调用较为耗时，且基于HiDebug模块定义，该模块内的接口仅建议在应用调试、调优阶段使用。若需要在其他场景使用时，请认真评估所需调用的接口对应用性能的影响。 > **说明：** > @@ -748,7 +748,7 @@ console.info(`totalMem: ${systemMemInfo.totalMem}, freeMem: ${systemMemInfo.free getVMRuntimeStats(): GcStats -获取系统gc全部统计信息。 +获取系统[GC](../../arkts-utils/gc-introduction.md)统计信息。 **系统能力**：SystemCapability.HiviewDFX.HiProfiler.HiDebug @@ -775,7 +775,7 @@ console.info(`fullgc-longtime-count: ${vMRuntimeStats['ark.gc.fullgc-longtime-co getVMRuntimeStat(item: string): number -根据参数获取指定的系统gc统计信息。 +根据参数获取指定的系统[GC](../../arkts-utils/gc-introduction.md)统计信息。 **系统能力**：SystemCapability.HiviewDFX.HiProfiler.HiDebug -- Gitee