Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Where is the Documentation for VSCode's Debug Adapter and Protocol implementation?

Đang mở
  • Có gì không ổn?
#450 1 bình luận 5 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
30/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
typescript, vscode
Lĩnh vực
developer-experience, documentation, tooling

Hướng nghiên cứu

Bắt đầu với Debugger Extension Guide, DAP specification, VS Code API Reference và VS Code Mock Debug, sau đó kiểm tra các tệp được tham chiếu debugProtocol.ts và loggingDebugSession.ts. So sánh phần mô tả của chúng với release notes của breakpointLocations và phần thảo luận issue được trích dẫn. Được xem là hoàn tất khi bổ sung ngữ cảnh chính thức giải thích mục đích của các capability, hành vi mà người dùng thấy được, cùng các tùy chọn và cơ chế của LoggingDebugSession.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

feature-request

I’ve been trying to work my way through Debugger Extension documentation to improve an existing debugger extension. My resources so far have been:

  1. Debugger Extension Guide
  2. Debug Adapter Protocol Overview
  3. Debug Adapter Protocol Specification
  4. VS Code API Reference
  5. VS Code Mock Debug

I would love to add "Documentation for VS Code's DAP Implementation" to that list, but I have unfortunately not been able to find it. The best I've found is using JSDoc-driven IntelliSense on this package, but that has been less helpful than expected.

When attempting to determine how to map DAP Capabilities to the debugger I'm integrating, it helps to have a good understanding of how VS Code is going to use a feature.

One good example would be the supportsBreakpointLocationRequest capability. Here is its JSDoc comment in its entirety:

The debug adapter supports the breakpointLocations request.

Okay... that sounds like a DAP reference. Let's look at what the specification has to say about BreakpointLocations Requests:

The breakpointLocations request returns all possible locations for source breakpoints in a given range.

At this point I'm still confused. Looking at the members of the related BreakpointLocationsArguments type provides a bit of insight, but it doesn't definitively help me understand what the purpose of this capability is...

A web search for related keywords finally turns up something helpful:

Finding possible breakpoints in a source range

The new breakpointLocations request can be used by a DAP client to find all possible breakpoint locations in a given source range. This can be used in the UI in order to improve the discoverability of "inline" ("column") breakpoints.

Ahh! This is how we enable column breakpoints! Got it! That helpful context was provided in VS Code release notes from September 2019...

Would it be possible to add this to some official documentation, whether that be in the DAP Specification or VS Code's specific implementation, or both?

Other examples that I've contended (or am still contending) with:

  1. The supportsSetExpression capability. I found the necessary context in a previous GitHub Issue.
  2. The LoggingDebugSession class. This is the base class for the VS Code Mock Debug project's MockDebugSession class. That project appears to be how Debug Extension architecture is currently communicated. There is no discussion about what options exist for base classes here and no documentation about what LoggingDebugSession provides beyond its base class (yes logging, but via what mechanism exactly?). The only way to know is to look to the source code and learn it.

In general, I think the documentation for the DAP and VS Code's specific implementation thereof could be greatly enhanced by providing deeper context for features. As someone newly interfacing with the API and familiar with my own debugger's capabilities, it would make my life much easier to understand what end-user experience is enabled by a feature/capability; to understand the "why" behind an API, rather than just the "what".

Ngôn ngữ chính
HTML
Star
1.8k
Fork
173
Merge trung bình
7 ngày 7 giờ
Pull request đã merge (30 ngày)
2

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của microsoft/debug-adapter-protocol

Tất cả issue của microsoft/debug-adapter-protocol

Issue tương tự

Thêm issue về DevTools

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.