CodeEditApp / CodeEditApp/CodeEdit

✨ Quick Help Inspector

未关闭
#364 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
enhancement inspector UI workspace
主要语言
Swift
星标
23k
派生
1.2k
PR 合并指标
30 天内没有已合并 PR

描述

### Description

A Quick Help inspector panel would provide inline documentation and type information for the symbol currently under the cursor or selected in the editor. This allows developers to quickly understand the purpose, usage, and context of functions, types, and variables without navigating away from their current position.

### Proposed Behavior

- When a user places the cursor over a symbol, its documentation is displayed in a dedicated inspector panel.
- The panel could include:
- Symbol name and kind (e.g., function, variable, type)
- Declaration signature
- Documentation comments
- Type information
- Module or file where the symbol is defined
- The panel updates contextually as the user moves the cursor or selects a new symbol.

### Implementation Notes

- Can be powered by existing Language Server Protocol (LSP) support using `textDocument/hover` and related requests.
- Could be placed in the inspector area or presented as a popover or sidebar panel.
- Should gracefully handle cases where no documentation is available.

### Benefits

- Improves developer productivity by reducing context-switching.
- Helps with onboarding and working in unfamiliar codebases.
- Provides fast, integrated access to symbol documentation and type hints.

### Additional Context

This is a common feature in modern development environments and would be a natural addition alongside outline views and inline diagnostics.

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

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