microsoft / microsoft/vscode-java-debug

Add Support For Showing a Custom Type View via TypeCustomDebugDataView or Annotations

未关闭
#1,162 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

ai-triaged enhancement feature request variables
主要语言
TypeScript
星标
591
派生
429
平均合并
1 天 9 小时
30 天内合并 PR
19

描述

Hi,

It seems currently vscode-java-debug doesn't support a way to have different representations of a type during debug in inline view, "variables" and "watch" windows.

Environment
  • Operating System: Windows 10 19043.1645 (x64)
  • JDK version: Java 11 (Oracle JDK 16)
  • Visual Studio Code version: 1.66.2
  • Java extension version: 1.6.0
  • Java Debugger extension version: 0.40.1
Steps To Reproduce
  1. Start a debugging session in vscode for any java file.
  2. See how class variables are represented in inline-view, "variables" and "watch" windows.
Current Result

For example, here is how it looks like during debug - inline view (extension version v0.40.1):
current-inline-view

and here is overridden toString method in the Point class:
point-ovirridden

notice, I have the following options in .vscode/settings.json:

{
  "java.debug.settings.showQualifiedNames": false,
  "java.debug.settings.showToString": true,
  "java.debug.settings.showLogicalStructure": true
}

also, when I expand an array in the variable view, the nested types are not showing until I click(...):
array-list-expanded-view

It seems there are no ways to enable a custom data view for a particular types, right?

Expected Result

It would be cool to have something like that:
inline-view-expected

It seems like it can be done using either:

  1. Adding an option to enable displaying a result of overridden toString method, e.g. java.debug.settings.showToStringInlineView: true
  2. Add "Java Type Renderer" to support custom data views similar to IntellijIdea "debugger -> Customize Data Views -> Java Type Renderer" (see link #1 in Additional Informations)
  3. Add something like DebuggerDisplay annotation similar to C# DebuggerDisplayAttribute (see link #2 in Additional Informatins)

For me the second way seems more appealing because it may allow setting custom debug views even for Java internal classes like java.utils.ArrayList

Additional Informations

For example, here are some StackOverflow questions that illustrate the problem:

  1. IntelliJ change toString for debug mode (variables view) | StackOverflow
  2. Display custom string in debugger variables | StackOverflow

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

未指定源文件、测试或入口点。首先跟踪 vscode-java-debug 如何在 inline、Variables 和 Watch 视图中呈现值,然后比较提议的 TypeCustomDebugDataView、annotation 和 toString 方案。完成标准是确定一个一致同意的设计,并在所请求的视图中支持自定义类型表示。

由索引模型根据 Issue 内容生成。

评估

技术栈
java, typescript
领域
devtools
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。