Skip to content

Commit 7c7274a

Browse files
committed
docs: basic readme
1 parent 794d0b5 commit 7c7274a

9 files changed

+126
-1
lines changed

.idea/codeStyles/Project.xml

+13
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/codeStyles/codeStyleConfig.xml

+5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/inspectionProfiles/Project_Default.xml

+6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/leetcode-practice-vscode.iml

+12
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/material_theme_project_new.xml

+3-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/modules.xml

+8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/vcs.xml

+6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/leetcode-practice-vscode.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# leetcode-practice-vscode
2+
3+
A extension on vs code for leetcode-practice.
4+
5+
## Use cases
6+
7+
1. 练习算法
8+
- 题目列表,排序,筛选,解题记录
9+
- 每日一题
10+
- 验证题目(任意语言的代码用例获取,代码运行)
11+
- 提交题解(登录模块,国际版和国内区分)
12+
- 提交代码(git)
13+
- 展示题目详情
14+
2. AI增强的题解助手
15+
- 读取当前运行文件为上下文,给出题解,详细解释算法原理
16+
- 对接deepseek,绑定api key
17+
3. 题目收集
18+
- 维护自定义的题目集合
19+
4. 插件相关
20+
- 更新模块

docs/leetcode-practice-vscode.puml

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
@startuml
2+
title VSCode LeetCode Practice Plugin Class Diagram
3+
4+
' 插件主入口
5+
class LeetCodePracticeExtension {
6+
- context: ExtensionContext
7+
- leetcodeService: LeetCodeService
8+
- aiService: AIService
9+
- webviewPanel: WebviewPanel
10+
+ activate(context: ExtensionContext): void
11+
+ deactivate(): void
12+
}
13+
14+
' LeetCode 服务类
15+
class LeetCodeService {
16+
- leetcodePracticePath: string
17+
+ getProblemList(): Problem[]
18+
+ getProblemDetail(id: string): ProblemDetail
19+
}
20+
21+
' AI 服务类
22+
class AIService {
23+
+ generateSolutionHint(problemId: string): string
24+
}
25+
26+
' 问题类
27+
class Problem {
28+
+ id: string
29+
+ title: string
30+
+ difficulty: string
31+
}
32+
33+
' 问题详情类
34+
class ProblemDetail {
35+
+ id: string
36+
+ title: string
37+
+ content: string
38+
+ codeTemplate: string
39+
}
40+
41+
' VSCode Webview 面板
42+
class WebviewPanel {
43+
- panel: WebviewPanel
44+
+ createOrShow(context: ExtensionContext): void
45+
+ updateContent(htmlContent: string): void
46+
}
47+
48+
LeetCodePracticeExtension --> LeetCodeService : 使用
49+
LeetCodePracticeExtension --> AIService : 使用
50+
LeetCodePracticeExtension --> WebviewPanel : 控制
51+
LeetCodeService --> Problem : 返回列表
52+
LeetCodeService --> ProblemDetail : 返回详情
53+
@enduml

0 commit comments

Comments
 (0)