refactor:项目架构重构和命名规范化

- 统一文件命名为snake_case格式(kebab-case  snake_case)
- 重构zulip模块为zulip_core,明确Core层职责
- 重构user-mgmt模块为user_mgmt,统一命名规范
- 调整模块依赖关系,优化架构分层
- 删除过时的文件和目录结构
- 更新相关文档和配置文件

本次重构涉及大量文件重命名和模块重组,
旨在建立更清晰的项目架构和统一的命名规范。
This commit is contained in:
moyin
2026-01-08 00:14:14 +08:00
parent 4fa4bd1a70
commit bb796a2469
178 changed files with 24767 additions and 3484 deletions

View File

@@ -11,6 +11,7 @@
- [WebSocket 实时通信](#websocket-实时通信)
- [数据验证](#数据验证)
- [异常处理](#异常处理)
- [注释规范](#注释规范)
## 核心概念
@@ -453,6 +454,142 @@ export class RoomController {
7. **日志记录**:使用内置 Logger 或集成第三方日志库
8. **测试**:编写单元测试和 E2E 测试
## 注释规范
### 文件头注释
每个 TypeScript 文件都应该包含完整的文件头注释:
```typescript
/**
* 文件功能描述
*
* 功能描述:
* - 主要功能点1
* - 主要功能点2
* - 主要功能点3
*
* 职责分离:
* - 职责描述1
* - 职责描述2
*
* 最近修改:
* - YYYY-MM-DD: 修改类型 - 具体修改内容描述
* - YYYY-MM-DD: 修改类型 - 具体修改内容描述
*
* @author 作者名
* @version x.x.x
* @since 创建日期
* @lastModified 最后修改日期
*/
```
### 类注释
```typescript
/**
* 类功能描述
*
* 职责:
* - 主要职责1
* - 主要职责2
*
* 主要方法:
* - method1() - 方法1功能
* - method2() - 方法2功能
*
* 使用场景:
* - 场景描述
*/
@Injectable()
export class ExampleService {
// 类实现
}
```
### 方法注释
```typescript
/**
* 方法功能描述
*
* 业务逻辑:
* 1. 步骤1描述
* 2. 步骤2描述
* 3. 步骤3描述
*
* @param param1 参数1描述
* @param param2 参数2描述
* @returns 返回值描述
* @throws ExceptionType 异常情况描述
*
* @example
* ```typescript
* const result = await service.methodName(param1, param2);
* ```
*/
async methodName(param1: string, param2: number): Promise<ResultType> {
// 方法实现
}
```
### 接口注释
```typescript
/**
* 接口功能描述
*/
export interface ExampleInterface {
/** 字段1描述 */
field1: string;
/** 字段2描述 */
field2: number;
/** 可选字段描述 */
optionalField?: boolean;
}
```
### 修改记录规范
当修改现有文件时,必须在文件头注释中添加修改记录:
#### 修改类型定义
- **代码规范优化** - 命名规范、注释规范、代码清理等
- **功能新增** - 添加新的功能或方法
- **功能修改** - 修改现有功能的实现
- **Bug修复** - 修复代码缺陷
- **性能优化** - 提升代码性能
- **重构** - 代码结构调整但功能不变
#### 修改记录格式
```typescript
/**
* 最近修改:
* - 2025-01-07: 代码规范优化 - 清理未使用的导入(EmailSendResult, crypto)
* - 2025-01-07: 代码规范优化 - 修复常量命名(saltRounds -> SALT_ROUNDS)
* - 2025-01-07: 功能新增 - 添加用户验证码登录功能
* - 2025-01-06: Bug修复 - 修复邮箱验证逻辑错误
*
* @version 1.0.1 (修改后需要递增版本号)
* @lastModified 2025-01-07
*/
```
**📏 修改记录长度限制只保留最近5次修改超出时删除最旧记录保持注释简洁。**
### 注释最佳实践
1. **保持更新**:修改代码时同步更新注释
2. **描述意图**:注释应该说明"为什么"而不只是"做什么"
3. **业务逻辑**:复杂的业务逻辑必须有详细的步骤说明
4. **异常处理**:明确说明可能抛出的异常和处理方式
5. **示例代码**:复杂方法提供使用示例
6. **版本管理**:修改文件时必须更新修改记录和版本号
## 更多资源
- [NestJS 官方文档](https://docs.nestjs.com/)