Dape - Debug Adapter Protocol for Emacs 使用教程

Dape - Debug Adapter Protocol for Emacs 使用教程

dape Debug Adapter Protocol for Emacs 项目地址: https://gitcode.com/gh_mirrors/da/dape

1. 项目目录结构及介绍

Dape 是一个为 Emacs 编辑器实现调试适配器协议（Debug Adapter Protocol）的开源项目。其目录结构如下：

• .github/
  • 存放与 GitHub 相关的工作流（如自动化测试等）。
• .elpaignore
  • 用于指定在执行 elpa 相关操作时需要忽略的文件。
• CHANGELOG.org
  • 记录项目的更新历史和版本变更。
• LICENSE
  • 项目使用的开源许可证文件（GPL-3.0）。
• Makefile
  • 用于构建项目的 Makefile 文件。
• README.org
  • 项目说明文件，包含项目介绍和使用说明。
• dape-tests.el
  • 包含对 Dape 功能的单元测试。
• dape.el
  • 主文件，实现了 Dape 的核心功能。

2. 项目的启动文件介绍

Dape 项目的启动主要依赖于 dape.el 文件。当你通过 Emacs 的包管理器安装 Dape 后，你可以通过以下命令启动调试会话：

M-x dape

在启动调试会话时，你需要在 Emacs 的 minibuffer 中输入一个调试适配器配置名称，该名称应存在于 dape-configs 中。

3. 项目的配置文件介绍

Dape 的配置主要通过 Emacs 的配置文件进行，例如 init.el 或项目特定的配置文件 .dir-locals.el。以下是一些常用的配置选项：

• dape-key-prefix: 用于设置 Dape 的快捷键前缀。
• dape-buffer-window-arrangement: 用于配置调试信息缓冲区的显示方式，可以是 right（在右侧显示）或 gud（类似 gdb 的显示方式）。
• dape-info-hide-mode-line: 设置是否隐藏调试信息缓冲区的模式行。
• dape-inlay-hints: 是否显示插入提示。

例如，以下是如何在 Emacs 配置文件中启用 Dape 并设置一些基本选项：

(use-package dape
  :preface
  ;; 设置快捷键前缀（可选）
  ;;
  ; (setq dape-key-prefix "\C-x\C-a")
  :hook
  ;; 退出时保存断点
  ;;
  ; (kill-emacs . dape-breakpoint-save)
  ;; 启动时加载断点
  ;;
  ; (after-init . dape-breakpoint-load)
  :config
  ;; 启用全局设置断点的鼠标模式
  ;;
  ; (dape-breakpoint-global-mode)
  ;; 设置信息缓冲区在右侧显示
  ;;
  ; (setq dape-buffer-window-arrangement 'right)
  )

确保在配置文件中正确设置 Dape 的相关选项，以获得最佳的使用体验。

dape Debug Adapter Protocol for Emacs 项目地址: https://gitcode.com/gh_mirrors/da/dape