openkylin
/
vscode-java-debug
mirror of https://gitee.com/openkylin/vscode-java-debug.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

Document debugger options (#62) 

* Document debugger options

* Resolve comments and add privacy statement

* Fix typo
This commit is contained in:
Rome Li 2017-09-27 11:10:09 +08:00 committed by GitHub
parent d53e141bfd
commit ae7127c4b6
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -38,6 +38,26 @@ Please also check the documentation of [Language Support for Java by Red Hat](ht
## Options
### Launch
- `mainClass` (required) - The main class of the program (fully qualified name, e.g. com.xyz.MainClass).
- `args` - The command line arguments passed to the program.
- `sourcePaths` - The extra source directories of the program. The debugger looks for source code from project settings by default. This option allows the debugger to look for source code in extra directories.
- `classPaths` - The classpaths for launching the JVM. If not specified, the debugger will automatically resolve from current project.
- `encoding` - The `file.encoding` setting for the JVM. If not specified, 'UTF-8' will be used. Possible values can be found in http://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html.
- `vmArgs` - The extra options and system properties for the JVM (e.g. -Xms\<size\> -Xmx\<size\> -D\<name\>=\<value\>).
- `projectName` - The preferred project in which the debugger searches for classes. There could be duplicated class names in different projects. This setting also works when the debugger looks for the specified main class when launching a program.
### Attach
- `hostName` (required) - The host name or IP address of remote debuggee.
- `port` (required) - The debug port of remote debuggee.
- `timeout` - Timeout value before reconnecting, in milliseconds (default to 30000ms).
- `sourcePaths` - The extra source directories of the program. The debugger looks for source code from project settings by default. This option allows the debugger to look for source code in extra directories.
- `projectName` - The preferred project in which the debugger searches for classes. There could be duplicated class names in different projects. This setting also works when the debugger looks for the specified main class when launching a program.
### User Settings
- `java.debug.logLevel`: minimum level of debugger logs that are sent to VS Code, defaults to `warn`.
## Feedback and Questions
@ -45,3 +65,6 @@ Please also check the documentation of [Language Support for Java by Red Hat](ht
Please share your feedback and ask questions to help us improve.
[![Gitter](https://badges.gitter.im/Microsoft/vscode-java-debug.svg)](https://gitter.im/Microsoft/vscode-java-debug)
## Data/Telemetry
Java Debug Extension for Visual Studio Code collects usage data and sends it to Microsoft to help improve our products and services. Read our [privacy statement](http://go.microsoft.com/fwlink/?LinkId=521839) to learn more.