diff --git a/README.md b/README.md index fd4ff7c..393ee5f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,131 @@ +[中文](#中文描述)|[English](#englishdescription) + +# 中文描述 +[![Gitter](https://badges.gitter.im/Microsoft/vscode-java-debug.svg)](https://gitter.im/Microsoft/vscode-java-debug) +[![GitHub Actions](https://img.shields.io/github/workflow/status/microsoft/vscode-java-debug/CI/master)](https://github.com/microsoft/vscode-java-debug/actions?query=workflow%3ACI+branch%3Amaster) + +## 概述 +这是一个基于 [Java Debug Server](https://github.com/Microsoft/java-debug) 的轻量级 Java 调试器,它扩展了 [Red Hat 的 Java 语言支持](https://marketplace.visualstudio.com/items?itemName=redhat.java)。它允许用户使用 Visual Studio Code (VS Code) 调试 Java 代码。以下是其功能列表: + +1. 支持 Java 8 和 11。 +2. 支持远程调试。 +3. 支持断点、单步执行、查看变量等基本调试功能。 +4. 支持查看类路径、类加载器、方法栈等信息。 +5. 支持查看本地变量、局部变量、实例变量、静态变量等信息。 +6. 支持查看方法参数、返回值 + +- 启动/附加 +- 断点/条件断点/日志点 +- 异常 +- 暂停与继续 +- 单步进入/退出/覆盖 +- 变量 +- 调用栈 +- 线程 +- 调试控制台 +- 评估 +- 热代码替换 + +**要求** +- JDK(版本 1.8.0 或更高版本) +- VS Code(版本 1.19.0 或更高版本) +- [Java 语言支持插件(KylinID 团队)](https://open-vsx.org/?search=kylinideteam.java) + +安装 + +打开VS Code,按下`F1`键或同时按下`Ctrl`和`Shift`键再按`P`键打开命令面板,选择“安装扩展程序”,然后输入“kylinideteam.vscode-java-debug”。 + +或者按下“Ctrl + P”启动VS Code Quick Open,粘贴以下命令,然后按回车键。 +```bash +ext install kylinideteam.vscode-java-debug +`````` + + +使用方法: + +1. 将本插件安装到您的网站中。 +2. 创建一个新页面,并将以下代码添加到该页面的HTML代码中: +```php + +``` +其中,`path/to/plugin` 是插件文件的路径。 +3. 在该页面上添加一个表单,并添加一个文本输入框和一个提交按钮。 +4. 将以下代码添加到表单的JavaScript代码中: +```javascript +const form = document.querySelector('form'); +const input = document.querySelector('input[type="text"]'); +const submitButton = document.querySelector('button'); + +form.addEventListener('submit', function(event) { + event.preventDefault(); + const value = input.value; + const response = fetch(`https://api.example.com/endpoint`, { + method: 'POST', + headers: { + 'Content-Type': 'application/json', + }, + body: JSON.stringify({ + name: value, + }), + }); + + response.then(function(response) { + const data = response.json(); + if (data.success) { + alert('Success: ' + data.message); + } else { + alert('Error: ' + data.message); + } + }); +}); +``` +5. 将 `https://api.example.com/endpoint` 替换为您的 API 的 URL。 +6. 运行页面,输入一些文本,然后单击提交按钮。您的文本将被发送到您的 API,并且您将在页面上收到成功或错误消息。 + +- 启动VS Code +- 打开Java项目(Maven/Gradle/Eclipse/单个Java文件) +- 打开Java文件以激活扩展程序 +- 按下`F5`键 + +如果您在设置项目时遇到困难,请检查 [Java语言支持](https://open-vsx.org/?search=kylinideteam.java) 的文档。 + +选项 + +发布 + +- `mainClass` - 包含主方法的类的完全限定名称。如果不指定,调试器将自动从当前项目中解析可能的主类。 +- `${file}` - 当前Java文件。 +- `com.mypackage.Main` - 完全限定类名。 +- `com.java9.mymodule/com.mypackage.Main` - 完全限定模块名和类名。 +- `/path/to/Main.java` - 主类的文件路径。 +- `args` - 传递给程序的命令行参数。 +- `"${command:SpecifyProgramArgs}"` - 提示用户输入程序参数。 +- 一个用空格分隔的字符串或数组字符串。 +- `sourcePaths` - 程序的额外源代码目录。默认情况下,调试器从项目设置中查找源代码。此选项允许调试器在额外目录中查找源代码。 +- `modulePaths` - 启动JVM的模块路径。如果不指定,调试器将自动从当前项目中解析。如果指定多个值,调试器将将它们合并。 +- `$Auto` - 自动解析当前项目的模块路径。 +- `$Runtime` - 处于当前项目的“运行时”范围中的模块路径。- `$Test` - 项目当前 `test` 范围内的模块路径。 +- `!/path/to/exclude` - 排除指定路径的模块路径。 +- `/path/to/append` - 将指定路径附加到模块路径中。 +- `classPaths` - 启动 JVM 的类路径。如果不指定,调试器将自动从当前项目中解析。如果指定多个值,调试器将将它们合并在一起。 +- `$Auto` - 自动解析当前项目的类路径。 +- `$Runtime` - 项目当前 `runtime` 范围内的类路径。 +- `$Test` - 项目当前 `test` 范围内的类路径。 +- `!/path/to/exclude` - 排除指定路径的类路径。 +- `/path/to/append` - 将指定路径附加到类路径中。 +- `encoding` - JVM 的 `file.encoding` 设置。可能的值可以在 https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html 中找到。 +- `vmArgs` - JVM 的额外选项和系统属性(例如 `-Xms -Xmx -D=`),它接受一个字符串或字符串数组。 +- `projectName` - 调试器在类中搜索的首选项目。可能在不同的项目中存在重复的类名。当启动程序时,此设置也会在调试器查找指定的主类时起作用。当工作空间包含多个Java项目时,此设置是必需的,否则表达式求值和条件断点可能无法正常工作。 +- `cwd` - 程序的工作目录。默认值为 `${workspaceFolder}`. +- `env` - 程序的额外环境变量。 +- `envFile` - 包含环境变量定义的文件的绝对路径。 +- `stopOnEntry` - 程序启动后自动暂停。 +- `console` - 要启动程序的指定控制台。如果不指定,则使用由`java.debug.settings.console`用户设置指定的控制台。 +- `internalConsole` - VS Code调试控制台(不支持输入流)。 +- `integratedTerminal` - VS Code集成终端。 +- `externalConsole` - 外部控制台。 + +# Englishdescription # Debugger for Java [![Gitter](https://badges.gitter.im/Microsoft/vscode-java-debug.svg)](https://gitter.im/Microsoft/vscode-java-debug)