refactor:项目架构重构和命名规范化
- 统一文件命名为snake_case格式(kebab-case snake_case) - 重构zulip模块为zulip_core,明确Core层职责 - 重构user-mgmt模块为user_mgmt,统一命名规范 - 调整模块依赖关系,优化架构分层 - 删除过时的文件和目录结构 - 更新相关文档和配置文件 本次重构涉及大量文件重命名和模块重组, 旨在建立更清晰的项目架构和统一的命名规范。
This commit is contained in:
@@ -37,6 +37,35 @@
|
||||
| [后端开发规范](./backend_development_guide.md) | 注释、日志、业务逻辑 | 注释完整性、日志规范 |
|
||||
| [NestJS 使用指南](./nestjs_guide.md) | 框架最佳实践 | 架构设计、代码组织 |
|
||||
|
||||
**📝 重要:修改记录注释规范**
|
||||
|
||||
当对现有文件进行修改时,必须在文件头注释中添加修改记录,格式如下:
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 文件功能描述
|
||||
*
|
||||
* 最近修改:
|
||||
* - YYYY-MM-DD: 修改类型 - 具体修改内容描述
|
||||
* - YYYY-MM-DD: 修改类型 - 具体修改内容描述
|
||||
*
|
||||
* @author 原作者
|
||||
* @version x.x.x (修改后递增版本号)
|
||||
* @since 创建日期
|
||||
* @lastModified 最后修改日期
|
||||
*/
|
||||
```
|
||||
|
||||
**📏 重要限制:修改记录只保留最近5次修改,超出时删除最旧记录,保持注释简洁。**
|
||||
|
||||
**修改类型包括:**
|
||||
- `代码规范优化` - 命名规范、注释规范、代码清理等
|
||||
- `功能新增` - 添加新的功能或方法
|
||||
- `功能修改` - 修改现有功能的实现
|
||||
- `Bug修复` - 修复代码缺陷
|
||||
- `性能优化` - 提升代码性能
|
||||
- `重构` - 代码结构调整但功能不变
|
||||
|
||||
---
|
||||
|
||||
## 🤖 AI 辅助开发工作流程
|
||||
@@ -89,6 +118,7 @@
|
||||
- 模块级注释(功能描述、依赖模块、作者、版本)
|
||||
- 类级注释(职责、主要方法、使用场景)
|
||||
- 方法级注释(功能描述、业务逻辑、参数、返回值、异常、示例)
|
||||
- 修改记录注释(如果是修改现有文件,添加修改记录和更新版本号)
|
||||
|
||||
2. 按照命名规范:
|
||||
- 类名使用大驼峰
|
||||
@@ -229,6 +259,7 @@
|
||||
□ 模块级注释(功能描述、依赖模块、作者、版本)
|
||||
□ 类级注释(职责、主要方法、使用场景)
|
||||
□ 方法级注释(功能描述、业务逻辑、参数、返回值、异常、示例)
|
||||
□ 修改记录注释(如果是修改现有文件,必须添加修改记录和更新版本号,只保留最近5次修改)
|
||||
□ 文件命名使用下划线分隔
|
||||
□ 类名使用大驼峰命名
|
||||
□ 方法名使用小驼峰命名
|
||||
@@ -312,7 +343,50 @@ AI 会生成包含完整注释和异常处理的代码。
|
||||
请按照 Git 提交规范生成提交信息。
|
||||
```
|
||||
|
||||
### 案例2:代码审查场景
|
||||
### 案例3:修改现有文件规范
|
||||
|
||||
#### 修改现有代码时的注释更新
|
||||
|
||||
```
|
||||
我需要修改现有的 login_core.service.ts 文件,进行以下优化:
|
||||
- 清理未使用的导入 (EmailSendResult, crypto)
|
||||
- 修复常量命名 (saltRounds -> SALT_ROUNDS)
|
||||
- 删除未使用的私有方法 (generateVerificationCode)
|
||||
|
||||
请帮我:
|
||||
1. 在文件头注释中添加修改记录
|
||||
2. 更新版本号 (1.0.0 -> 1.0.1)
|
||||
3. 添加 @lastModified 标记
|
||||
4. 确保修改记录格式符合规范
|
||||
5. 只保留最近5次修改记录,保持注释简洁
|
||||
|
||||
修改记录格式要求:
|
||||
- 日期格式:YYYY-MM-DD
|
||||
- 修改类型:代码规范优化
|
||||
- 描述要具体明确
|
||||
- 最多保留5条记录
|
||||
```
|
||||
|
||||
#### AI 生成的修改记录示例
|
||||
|
||||
```typescript
|
||||
/**
|
||||
* 登录核心服务
|
||||
*
|
||||
* 最近修改:
|
||||
* - 2025-01-07: 代码规范优化 - 清理未使用的导入(EmailSendResult, crypto)
|
||||
* - 2025-01-07: 代码规范优化 - 修复常量命名(saltRounds -> SALT_ROUNDS)
|
||||
* - 2025-01-07: 代码规范优化 - 删除未使用的私有方法(generateVerificationCode)
|
||||
* - 2025-01-07: 代码质量提升 - 确保完全符合项目命名规范和注释规范
|
||||
*
|
||||
* @author moyin
|
||||
* @version 1.0.1
|
||||
* @since 2025-12-17
|
||||
* @lastModified 2025-01-07
|
||||
*/
|
||||
```
|
||||
|
||||
### 案例4:代码审查场景
|
||||
|
||||
#### 现有代码检查
|
||||
|
||||
@@ -380,6 +454,14 @@ AI 会生成包含完整注释和异常处理的代码。
|
||||
- 日志记录
|
||||
- 规范命名
|
||||
|
||||
## 代码修改模板
|
||||
修改现有文件时,请:
|
||||
- 在文件头注释添加修改记录
|
||||
- 更新版本号(递增小版本号)
|
||||
- 添加 @lastModified 标记
|
||||
- 修改记录格式:YYYY-MM-DD: 修改类型 - 具体描述
|
||||
- 只保留最近5次修改记录,保持注释简洁
|
||||
|
||||
## 代码检查模板
|
||||
请检查代码规范符合性:
|
||||
[保存检查清单]
|
||||
@@ -397,6 +479,7 @@ AI 会生成包含完整注释和异常处理的代码。
|
||||
3. 异常处理模板
|
||||
4. 日志记录模板
|
||||
5. 参数验证模板
|
||||
6. 文件修改记录注释模板
|
||||
|
||||
每个模板都要包含完整的注释和最佳实践。
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user