CodeEditApp / CodeEditApp/CodeEdit

✨ Quick Help Inspector

オープン
#364 コメント 0 件 リアクション 0 件 担当者 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 を短くまとめたダイジェスト。