forked from datawhale/whale-town-end
refactor:项目架构重构和命名规范化
- 统一文件命名为snake_case格式(kebab-case snake_case) - 重构zulip模块为zulip_core,明确Core层职责 - 重构user-mgmt模块为user_mgmt,统一命名规范 - 调整模块依赖关系,优化架构分层 - 删除过时的文件和目录结构 - 更新相关文档和配置文件 本次重构涉及大量文件重命名和模块重组, 旨在建立更清晰的项目架构和统一的命名规范。
This commit is contained in:
@@ -10,6 +10,7 @@
|
||||
- [常量命名](#常量命名)
|
||||
- [接口路由命名](#接口路由命名)
|
||||
- [TypeScript 特定规范](#typescript-特定规范)
|
||||
- [注释命名规范](#注释命名规范)
|
||||
- [命名示例](#命名示例)
|
||||
|
||||
## 文件和文件夹命名
|
||||
@@ -331,6 +332,111 @@ class Repository<type, key> { }
|
||||
@IsString({ message: 'name_must_be_string' })
|
||||
```
|
||||
|
||||
## 注释命名规范
|
||||
|
||||
### 注释标签命名
|
||||
|
||||
**规则:使用标准JSDoc标签**
|
||||
|
||||
```typescript
|
||||
✅ 正确示例:
|
||||
@param userId 用户ID
|
||||
@returns 用户信息
|
||||
@throws NotFoundException 用户不存在时
|
||||
@author moyin
|
||||
@version 1.0.0
|
||||
@since 2025-01-07
|
||||
@lastModified 2025-01-07
|
||||
|
||||
❌ 错误示例:
|
||||
@参数 userId 用户ID
|
||||
@返回 用户信息
|
||||
@异常 NotFoundException 用户不存在时
|
||||
@作者 moyin
|
||||
```
|
||||
|
||||
### 修改记录命名
|
||||
|
||||
**规则:使用标准化的修改类型**
|
||||
|
||||
```typescript
|
||||
✅ 正确示例:
|
||||
- 2025-01-07: 代码规范优化 - 清理未使用的导入
|
||||
- 2025-01-07: 功能新增 - 添加用户验证功能
|
||||
- 2025-01-07: Bug修复 - 修复登录验证逻辑
|
||||
- 2025-01-07: 性能优化 - 优化数据库查询
|
||||
- 2025-01-07: 重构 - 重构用户服务架构
|
||||
|
||||
❌ 错误示例:
|
||||
- 2025-01-07: 修改 - 改了一些代码
|
||||
- 2025-01-07: 更新 - 更新了功能
|
||||
- 2025-01-07: 优化 - 优化了性能
|
||||
- 2025-01-07: 调整 - 调整了结构
|
||||
```
|
||||
|
||||
**📏 长度限制:修改记录只保留最近5次修改,保持文件头注释简洁。**
|
||||
|
||||
### 注释内容命名
|
||||
|
||||
**规则:使用清晰描述性的中文**
|
||||
|
||||
```typescript
|
||||
✅ 正确示例:
|
||||
/** 用户唯一标识符 */
|
||||
userId: string;
|
||||
|
||||
/** 用户邮箱地址,用于登录和通知 */
|
||||
email: string;
|
||||
|
||||
/** 用户状态:active-激活, inactive-未激活, banned-已封禁 */
|
||||
status: UserStatus;
|
||||
|
||||
/**
|
||||
* 验证用户登录凭据
|
||||
*
|
||||
* 业务逻辑:
|
||||
* 1. 验证用户名或邮箱格式
|
||||
* 2. 查找用户记录
|
||||
* 3. 验证密码哈希值
|
||||
* 4. 检查用户状态
|
||||
*/
|
||||
|
||||
❌ 错误示例:
|
||||
/** id */
|
||||
userId: string;
|
||||
|
||||
/** 邮箱 */
|
||||
email: string;
|
||||
|
||||
/** 状态 */
|
||||
status: UserStatus;
|
||||
|
||||
/**
|
||||
* 登录
|
||||
*/
|
||||
```
|
||||
|
||||
### 版本号命名规范
|
||||
|
||||
**规则:使用语义化版本号**
|
||||
|
||||
```typescript
|
||||
✅ 正确示例:
|
||||
@version 1.0.0 // 主版本.次版本.修订版本
|
||||
@version 1.2.3 // 功能更新
|
||||
@version 2.0.0 // 重大更新
|
||||
|
||||
修改时版本递增规则:
|
||||
- 代码规范优化、Bug修复 → 修订版本 +1 (1.0.0 → 1.0.1)
|
||||
- 功能新增、功能修改 → 次版本 +1 (1.0.1 → 1.1.0)
|
||||
- 重构、架构变更 → 主版本 +1 (1.1.0 → 2.0.0)
|
||||
|
||||
❌ 错误示例:
|
||||
@version v1 // 缺少详细版本号
|
||||
@version 1 // 格式不规范
|
||||
@version latest // 不明确的版本标识
|
||||
```
|
||||
|
||||
## 命名示例
|
||||
|
||||
### 完整的模块示例
|
||||
@@ -483,6 +589,11 @@ export class CreatePlayerDto {
|
||||
- [ ] 函数名清晰表达其功能
|
||||
- [ ] 布尔变量使用 is/has/can 前缀
|
||||
- [ ] 避免使用无意义的缩写
|
||||
- [ ] 注释使用标准JSDoc标签
|
||||
- [ ] 修改记录使用标准化修改类型
|
||||
- [ ] 版本号遵循语义化版本规范
|
||||
- [ ] 修改现有文件时添加了修改记录和更新版本号
|
||||
- [ ] 修改记录只保留最近5次,保持注释简洁
|
||||
|
||||
## 工具配置
|
||||
|
||||
|
||||
Reference in New Issue
Block a user