注解配置

注解允许您在代码执行期间自定义代码的可视化方式。通过在代码中特定位置添加特殊注释,您可以根据需要控制可视化行为。

可用注解

@ignore-function-tree

用途:防止可视化工具在可视化树中绘制函数调用节点。

使用方法:将此注解直接放置在函数定义上方。

示例

使用场景:此注解在以下情况特别有用:

  • 可视化递归算法,特别是树遍历
  • 您想要关注数据结构操作而不是函数调用
  • 函数调用树会给可视化增加不必要的复杂性

可视化工具将不会为每个递归调用显示新的函数节点,而是只显示树节点之间的移动,使可视化更清晰并更专注于算法的行为。

@function-tree-once

用途:防止可视化工具在多个子树中绘制函数调用节点。

使用方法:将此注解直接放置在函数定义上方。

示例

使用场景:此注解在以下情况特别有用:

  • 您想要可视化递归函数调用但避免在不同子树中重复表示相同的函数
  • 函数调用树会因为相同函数的重复实例而变得过于混乱
  • 您希望保持算法流程的可视化更简洁清晰

@skip-function

用途:完全跳过函数的可视化执行,直接返回函数结果。

使用方法:将此注解直接放置在函数定义上方。

示例

使用场景:此注解在以下情况特别有用:

  • 函数是工具函数或辅助函数,其内部逻辑与可视化无关。
  • 您希望关注更高层次的操作,避免因简单或已理解的函数而干扰可视化。
  • 函数的执行过程较为简单,对算法的理解没有显著贡献。

即将推出

计划在未来版本中添加更多注解类型,以提供对以下方面的更大控制:

  • 变量跟踪
  • 执行速度
  • 视觉样式
  • 调试点
  • 自定义可视化事件

请继续关注平台添加的新注解功能的更新。

最佳实践

  1. 将注解直接放置在相关代码上方的单独一行
  2. 适度使用注解以保持清晰的可视化效果
  3. 在决定显示或隐藏执行的哪些部分时,要考虑您的受众

反馈和建议

如果您对新的注解类型或现有注解的改进有想法,欢迎为项目做出贡献或提交功能请求。