Vim-Debug 项目技术文档

1. 安装指南

1.1 安装依赖

首先，确保你已经安装了 dbgp，这是 Vim-Debug 插件的依赖项。你可以通过以下命令安装：

sudo pip install dbgp

1.2 安装 Vim-Debug 插件

接下来，使用你喜欢的 Vim 插件管理器安装 vim-debug 插件。以下是几种常见的插件管理器的安装方法：

使用 Pathogen

git clone https://github.com/jabapyth/vim-debug.git ~/.vim/bundle/vim-debug

使用 Vundle

在你的 .vimrc 文件中添加以下行：

Plugin 'jabapyth/vim-debug'

然后运行 :PluginInstall。

使用 vim-plug

在你的 .vimrc 文件中添加以下行：

Plug 'jabapyth/vim-debug'

然后运行 :PlugInstall。

2. 项目的使用说明

2.1 启动调试会话

要启动调试会话，可以使用以下命令：

• Dbg：不自动启动调试。
• Dbg .：自动启动当前 Python 文件。
• Dbg url：自动启动指定的 PHP URL。
• Dbg num：自动启动之前调试过的 PHP URL（最多保存最近 5 个 URL）。

2.2 调试命令

Vim-Debug 提供了多种调试命令，以下是常用命令及其默认快捷键：

• quit：退出调试器。
• run：继续执行直到遇到断点或程序结束（默认快捷键：\r）。
• stop：停止调试器。
• over：单步跳过下一个函数调用（默认快捷键：\o）。
• watch：执行监视表达式（默认快捷键：\w）。
• up：向上移动堆栈（默认快捷键：\u）。
• here：继续执行直到光标位置（临时断点，默认快捷键：\h）。
• down：向下移动堆栈（默认快捷键：\d）。
• exit：退出调试器。
• eval：执行代码。
• break：设置断点（默认快捷键：\b）。
• into：单步进入下一个函数调用（默认快捷键：\i）。
• out：单步跳出当前函数调用（默认快捷键：\t）。

2.3 禁用默认快捷键

如果你不想使用默认的快捷键映射，可以在 debugger.vim 文件中设置以下变量：

let g:vim_debug_disable_mappings = 1

3. 项目API使用文档

Vim-Debug 插件通过与 xdebug 集成，提供了丰富的调试功能。以下是一些关键的 API 功能：

• 断点设置与移除：通过 break 命令设置断点，通过 quit 命令移除断点。
• 监视表达式：通过 watch 命令监视表达式的值。
• 堆栈视图：通过 up 和 down 命令在堆栈中移动。
• 代码执行：通过 run 和 eval 命令执行代码。

4. 项目安装方式

4.1 通过插件管理器安装

如前所述，你可以通过 Pathogen、Vundle 或 vim-plug 等插件管理器安装 vim-debug 插件。

4.2 手动安装

如果你不想使用插件管理器，也可以手动安装：

1. 克隆仓库：

   git clone https://github.com/jabapyth/vim-debug.git
   

2. 将插件文件夹复制到你的 .vim 目录下：

   cp -r vim-debug ~/.vim/
   

通过以上步骤，你就可以成功安装并使用 Vim-Debug 插件进行代码调试了。