Skip to content

Commit bdfd9d2

Browse files
committed
Merge branch 'main' of github.com:fuck-algorithm/leetcode-234-palindrome-linked-list
2 parents b66381f + 1702963 commit bdfd9d2

37 files changed

+23972
-230
lines changed

CURSOR_RULE.md

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
# 项目编码规范和开发指南
2+
3+
## 核心规则
4+
5+
1. **始终使用中文回答**
6+
- 所有代码注释必须使用中文
7+
- 所有用户文档必须使用中文
8+
- 所有提交信息和代码审查评论必须使用中文
9+
10+
2. **代码质量和模块化**
11+
- 代码应该优雅可维护,遵循清晰的设计模式
12+
- 单个文件的代码行数不得超过200行,超过应当拆分为独立模块
13+
- 每个函数应该只做一件事情,函数长度应该控制在50行以内
14+
- 使用有意义的变量名和函数名,避免无意义的缩写
15+
16+
## 文件拆分指南
17+
18+
当文件超过200行时,应遵循以下指南进行重构:
19+
20+
1. **按功能拆分**
21+
- 将不同功能的组件拆分到独立文件中
22+
- 例如:`PalindromeVisualization.tsx`中的`NodeComponent``LinkComponent`等应分别移至`components/`目录下
23+
24+
2. **按类型拆分**
25+
- 将常量、类型定义、工具函数等分别放在独立文件中
26+
- 例如:颜色常量应单独放在`constants/colors.ts`
27+
28+
3. **示例重构建议**
29+
- 当前`PalindromeVisualization.tsx`超过1400行,应拆分为:
30+
* `visualizations/components/NodeComponent.tsx`
31+
* `visualizations/components/LinkComponent.tsx`
32+
* `visualizations/components/IndicatorComponent.tsx`
33+
* `visualizations/components/LegendComponent.tsx`
34+
* `visualizations/constants/VisualizationConstants.ts`
35+
* `visualizations/PalindromeVisualization.tsx`(主组件)
36+
37+
## 代码风格指南
38+
39+
1. **排版与格式**
40+
- 使用2个空格进行缩进(不使用Tab)
41+
- 每行不超过100个字符
42+
- 花括号始终使用K&R风格(左括号不换行)
43+
- 函数参数超过3个时应换行
44+
45+
2. **命名约定**
46+
- 组件使用PascalCase(如`NodeComponent`
47+
- 函数和变量使用camelCase(如`getNodePosition`
48+
- 常量使用UPPER_SNAKE_CASE(如`NODE_RADIUS`
49+
- 类型和接口使用PascalCase(如`NodeData`
50+
51+
3. **React最佳实践**
52+
- 使用函数组件和Hooks,避免使用类组件
53+
- 使用`useMemo``useCallback`优化性能
54+
- 避免在渲染过程中进行复杂计算
55+
- 组件props应该使用TypeScript类型定义
56+
57+
## 代码评审清单
58+
59+
提交代码前,确保:
60+
61+
- [ ] 文件行数未超过200行
62+
- [ ] 函数行数未超过50行
63+
- [ ] 所有注释和变量名使用中文
64+
- [ ] 没有未使用的导入和变量
65+
- [ ] 所有可能的错误情况都有处理
66+
- [ ] 符合项目的TypeScript规范
67+
- [ ] 性能敏感的部分使用了适当的优化
68+
69+
## 实施建议
70+
71+
1. **现有代码重构计划**
72+
- 优先重构`PalindromeVisualization.tsx`文件(超过1400行)
73+
- 其次重构`AlgorithmExplanation.tsx`文件(超过200行)
74+
- 最后重构`palindromeChecker.ts`文件
75+
76+
2. **新功能开发规范**
77+
- 在开发新功能前先设计组件结构
78+
- 确保新增代码符合模块化原则
79+
- 每个PR应包含对应的文档更新
80+
81+
# 游标规则 (Cursor Rules)
82+
83+
本项目遵循以下游标规则,所有项目贡献者和 AI 助手均需遵守这些规则。
84+
85+
## 语言要求
86+
87+
1. **使用中文回答** - 所有交流、注释和文档必须使用中文,包括代码注释。English should not be used unless it's part of a technical term or code. AI助手必须始终使用中文回复用户,即使用户使用其他语言提问。
88+
89+
## 代码质量与风格
90+
91+
1. **代码优雅可维护** - 代码应该简洁、清晰,遵循良好的编程实践,并使用有意义的变量和函数名称。
92+
93+
2. **模块化设计** - 将功能拆分为独立的模块和组件,每个模块应当有明确的职责。
94+
95+
3. **文件大小限制** - 单个文件不应超过 200 行代码。如果超过该限制,应该将其重构为多个独立的小模块。
96+
97+
4. **类型安全** - 使用 TypeScript 的类型系统确保代码类型安全,避免使用 `any` 类型。
98+
99+
5. **注释规范** - 为每个组件、函数和复杂逻辑添加适当的注释,解释其用途和工作原理。
100+
101+
## 组件设计原则
102+
103+
1. **单一职责** - 每个组件只负责一个功能或表示一种视觉元素。
104+
105+
2. **可复用性** - 组件应当设计为可复用的,避免重复代码。
106+
107+
3. **props 接口** - 每个组件应当有明确定义的 props 接口,使用 TypeScript 类型来约束。
108+
109+
4. **逻辑与视图分离** - 将业务逻辑与视图渲染分离,使用自定义 hooks 管理复杂状态和副作用。
110+
111+
## 项目结构
112+
113+
1. **目录组织** - 项目应遵循清晰的目录结构,相关功能应当放在一起。
114+
115+
2. **命名约定** - 使用一致的文件和目录命名约定:
116+
- 组件文件名使用 PascalCase(如 `NodeComponent.tsx`
117+
- 工具和钩子函数使用 camelCase(如 `palindromeChecker.ts`
118+
- 常量文件使用 PascalCase 后缀 Constants(如 `VisualizationConstants.ts`
119+
120+
3. **导入顺序** - 导入语句应按照以下顺序排列:
121+
- React 和外部库
122+
- 项目内部组件
123+
- 工具函数和常量
124+
- 样式文件
125+
126+
## 视觉设计和交互
127+
128+
1. **响应式设计** - 组件应当能够适应不同屏幕尺寸和设备。
129+
130+
2. **可访问性** - 确保组件符合 Web 可访问性标准,包括适当的 ARIA 属性和键盘导航。
131+
132+
3. **一致的视觉语言** - 保持一致的颜色、字体和间距,创建统一的用户体验。
133+
134+
## 性能考虑
135+
136+
1. **避免不必要的渲染** - 使用 `React.memo``useMemo``useCallback` 来避免不必要的重新渲染。
137+
138+
2. **异步加载** - 对于大型组件或不是立即需要的功能,考虑使用异步加载。
139+
140+
3. **性能监控** - 定期检查组件性能,确保良好的用户体验。
141+
142+
---
143+
144+
遵循这些规则将帮助我们维护一个干净、高效且可维护的代码库。

fix-layout.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

0 commit comments

Comments
 (0)