microsoft / microsoft/vscode-java-debug

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

オープン
#1,162 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

ai-triaged enhancement feature request variables
主要言語
TypeScript
スター
591
フォーク
429
平均マージ
1日 9時間
マージ済み PR(30日)
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. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

ソースファイル、テスト、エントリポイントは指定されていません。まず、vscode-java-debug が inline、Variables、Watch ビューで値をどのようにレンダリングするかを追跡し、次に提案されている TypeCustomDebugDataView、annotation、toString のアプローチを比較します。完了の定義は、合意された設計と、要求されたビュー全体でのカスタム型表現のサポートです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java, typescript
領域
devtools
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。