vscode-hexdump 项目技术文档

vscode-hexdump 项目技术文档

安装指南

系统要求

• Visual Studio Code 版本 1.17.0 或更高

安装步骤

1. 安装 Visual Studio Code。
2. 启动 Visual Studio Code。
3. 打开命令面板：
   • Windows 和 Linux 用户：按 Ctrl+Shift+P。
   • macOS 用户：按 Cmd+Shift+P。
4. 选择 Install Extension。
5. 在扩展市场中搜索 hexdump for VSCode，然后选择安装。
6. 安装完成后，重新加载 Visual Studio Code。

项目的使用说明

主要功能

• 显示十六进制文件：在资源管理器中右键点击文件，选择 Show Hexdump 即可显示文件的十六进制内容。
• 悬停查看数值：在数据区域悬停鼠标，可以查看数值。
• 悬停预览字符串：选择部分内容并悬停，可以预览其字符串表示。
• 右键菜单选项：在十六进制显示区域右键点击，可以查看更多选项。
• 修改字节颜色：修改的字节会以不同颜色显示。
• 显示 Hexdump 按钮：在标题栏显示 Show Hexdump 按钮。

命令列表

• hexdumpFile (Ctrl+Shift+Alt+H, Cmd+Shift+Alt+H)：显示当前文件的十六进制内容。
• hexdumpPath：显示指定路径文件的十六进制内容。
• hexdumpOpen：通过打开对话框选择文件并显示其十六进制内容。
• editValue (Shift+Enter)：编辑光标下的值。
• gotoAddress (Ctrl+G)：跳转到指定地址。
• exportToFile (Ctrl+Shift+S, Cmd+Shift+S)：导出为二进制文件。
• save (Ctrl+S, Cmd+S)：保存文件。
• searchString (Ctrl+F, Cmd+F)：在文件中搜索字符串。
• searchHex (Ctrl+Alt+F, Cmd+Alt+F)：在文件中搜索十六进制字符串。
• copyAsFormat (Ctrl+Alt+C, Cmd+Alt+C)：以特定格式复制选中的内容。

项目API使用文档

配置选项

• hexdump.littleEndian：设置默认的字节序（true 为小端序，false 为大端序）。
• hexdump.nibbles：每组多少个半字节（2, 4, 8）。
• hexdump.uppercase：显示大写的十六进制数字。
• hexdump.width：每行显示的字节数（8, 16, 32）。
• hexdump.showOffset：在第一行显示偏移量。
• hexdump.showAddress：在每行显示地址。
• hexdump.showAscii：显示 ASCII 部分。
• hexdump.showInspector：悬停数据时显示 Hex Inspector。
• hexdump.sizeWarning：如果文件大小超过此值，显示警告。
• hexdump.sizeDisplay：显示的最大缓冲区大小。
• hexdump.charEncoding：识别源字符编码。
• hexdump.btnEnabled：显示 Hexdump 按钮。

项目安装方式

通过 Visual Studio Code 扩展市场安装

1. 打开 Visual Studio Code。
2. 进入扩展市场。
3. 搜索 hexdump for VSCode。
4. 点击安装。
5. 安装完成后，重新加载 Visual Studio Code。

通过命令行安装

1. 打开终端。
2. 使用以下命令安装扩展：

   code --install-extension slevesque.vscode-hexdump
   

3. 安装完成后，重新加载 Visual Studio Code。

通过以上步骤，您可以顺利安装并使用 vscode-hexdump 扩展，方便地查看和编辑文件的十六进制内容。