docs: 完成所有文档的中文翻译并应用到项目

This commit is contained in:
xuxiang
2026-01-28 00:12:54 +08:00
parent 0ced59a26b
commit e133f58e1c
76 changed files with 6808 additions and 6170 deletions

View File

@@ -1,72 +1,72 @@
---
name: coding-standards
description: Universal coding standards, best practices, and patterns for TypeScript, JavaScript, React, and Node.js development.
description: 适用于 TypeScriptJavaScriptReact Node.js 开发的通用编码标准、最佳实践和模式。
---
# Coding Standards & Best Practices
# 编码标准与最佳实践(Coding Standards & Best Practices
Universal coding standards applicable across all projects.
适用于所有项目的通用编码标准。
## Code Quality Principles
## 代码质量原则(Code Quality Principles
### 1. Readability First
- Code is read more than written
- Clear variable and function names
- Self-documenting code preferred over comments
- Consistent formatting
### 1. 可读性优先(Readability First
- 代码被阅读的次数远多于编写的次数
- 使用清晰的变量和函数名称
- 优先选择自解释代码,而非过多注释
- 保持一致的格式化风格
### 2. KISS (Keep It Simple, Stupid)
- Simplest solution that works
- Avoid over-engineering
- No premature optimization
- Easy to understand > clever code
### 2. KISS 原则(Keep It Simple, Stupid
- 采用最简单的可行方案
- 避免过度工程Over-engineering
- 拒绝过早优化
- 易于理解胜过奇技淫巧
### 3. DRY (Don't Repeat Yourself)
- Extract common logic into functions
- Create reusable components
- Share utilities across modules
- Avoid copy-paste programming
### 3. DRY 原则(Don't Repeat Yourself
- 将公共逻辑提取到函数中
- 创建可复用的组件
- 在模块间共享工具函数Utilities
- 避免复制粘贴式编程
### 4. YAGNI (You Aren't Gonna Need It)
- Don't build features before they're needed
- Avoid speculative generality
- Add complexity only when required
- Start simple, refactor when needed
### 4. YAGNI 原则(You Aren't Gonna Need It
- 不要在需求出现前构建功能
- 避免投机性的通用化设计
- 仅在必要时增加复杂性
- 从简单开始,在需要时重构
## TypeScript/JavaScript Standards
## TypeScript/JavaScript 标准
### Variable Naming
### 变量命名
```typescript
// ✅ GOOD: Descriptive names
// ✅ 推荐:描述性名称
const marketSearchQuery = 'election'
const isUserAuthenticated = true
const totalRevenue = 1000
// ❌ BAD: Unclear names
// ❌ 糟糕:语义不明
const q = 'election'
const flag = true
const x = 1000
```
### Function Naming
### 函数命名
```typescript
// ✅ GOOD: Verb-noun pattern
// ✅ 推荐:动词-名词模式
async function fetchMarketData(marketId: string) { }
function calculateSimilarity(a: number[], b: number[]) { }
function isValidEmail(email: string): boolean { }
// ❌ BAD: Unclear or noun-only
// ❌ 糟糕:语义不明或仅有名词
async function market(id: string) { }
function similarity(a, b) { }
function email(e) { }
```
### Immutability Pattern (CRITICAL)
### 不可变模式(Immutability Pattern - 至关重要)
```typescript
// ✅ ALWAYS use spread operator
// ✅ 始终使用展开运算符Spread Operator
const updatedUser = {
...user,
name: 'New Name'
@@ -74,15 +74,15 @@ const updatedUser = {
const updatedArray = [...items, newItem]
// ❌ NEVER mutate directly
user.name = 'New Name' // BAD
items.push(newItem) // BAD
// ❌ 严禁直接修改Mutate
user.name = 'New Name' // 糟糕
items.push(newItem) // 糟糕
```
### Error Handling
### 错误处理(Error Handling
```typescript
// ✅ GOOD: Comprehensive error handling
// ✅ 推荐:全面的错误处理
async function fetchData(url: string) {
try {
const response = await fetch(url)
@@ -98,33 +98,33 @@ async function fetchData(url: string) {
}
}
// ❌ BAD: No error handling
// ❌ 糟糕:缺少错误处理
async function fetchData(url) {
const response = await fetch(url)
return response.json()
}
```
### Async/Await Best Practices
### Async/Await 最佳实践
```typescript
// ✅ GOOD: Parallel execution when possible
// ✅ 推荐:尽可能并行执行
const [users, markets, stats] = await Promise.all([
fetchUsers(),
fetchMarkets(),
fetchStats()
])
// ❌ BAD: Sequential when unnecessary
// ❌ 糟糕:非必要的串行执行
const users = await fetchUsers()
const markets = await fetchMarkets()
const stats = await fetchStats()
```
### Type Safety
### 类型安全(Type Safety
```typescript
// ✅ GOOD: Proper types
// ✅ 推荐:定义明确的类型
interface Market {
id: string
name: string
@@ -133,21 +133,21 @@ interface Market {
}
function getMarket(id: string): Promise<Market> {
// Implementation
// 实现代码
}
// ❌ BAD: Using 'any'
// ❌ 糟糕:使用 'any'
function getMarket(id: any): Promise<any> {
// Implementation
// 实现代码
}
```
## React Best Practices
## React 最佳实践
### Component Structure
### 组件结构(Component Structure
```typescript
// ✅ GOOD: Functional component with types
// ✅ 推荐:带类型的函数式组件
interface ButtonProps {
children: React.ReactNode
onClick: () => void
@@ -172,16 +172,16 @@ export function Button({
)
}
// ❌ BAD: No types, unclear structure
// ❌ 糟糕:无类型,结构不明
export function Button(props) {
return <button onClick={props.onClick}>{props.children}</button>
}
```
### Custom Hooks
### 自定义 HookCustom Hooks
```typescript
// ✅ GOOD: Reusable custom hook
// ✅ 推荐:可复用的自定义 Hook
export function useDebounce<T>(value: T, delay: number): T {
const [debouncedValue, setDebouncedValue] = useState<T>(value)
@@ -196,55 +196,55 @@ export function useDebounce<T>(value: T, delay: number): T {
return debouncedValue
}
// Usage
// 使用示例
const debouncedQuery = useDebounce(searchQuery, 500)
```
### State Management
### 状态管理(State Management
```typescript
// ✅ GOOD: Proper state updates
// ✅ 推荐:正确的状态更新方式
const [count, setCount] = useState(0)
// Functional update for state based on previous state
// 基于前一个状态的函数式更新
setCount(prev => prev + 1)
// ❌ BAD: Direct state reference
setCount(count + 1) // Can be stale in async scenarios
// ❌ 糟糕:直接引用状态
setCount(count + 1) // 在异步场景下可能会获取到旧值
```
### Conditional Rendering
### 条件渲染(Conditional Rendering
```typescript
// ✅ GOOD: Clear conditional rendering
// ✅ 推荐:清晰的条件渲染
{isLoading && <Spinner />}
{error && <ErrorMessage error={error} />}
{data && <DataDisplay data={data} />}
// ❌ BAD: Ternary hell
// ❌ 糟糕:三元运算符地狱
{isLoading ? <Spinner /> : error ? <ErrorMessage error={error} /> : data ? <DataDisplay data={data} /> : null}
```
## API Design Standards
## API 设计标准
### REST API Conventions
### REST API 惯例
```
GET /api/markets # List all markets
GET /api/markets/:id # Get specific market
POST /api/markets # Create new market
PUT /api/markets/:id # Update market (full)
PATCH /api/markets/:id # Update market (partial)
DELETE /api/markets/:id # Delete market
GET /api/markets # 列出所有市场
GET /api/markets/:id # 获取特定市场
POST /api/markets # 创建新市场
PUT /api/markets/:id # 更新市场(完整更新)
PATCH /api/markets/:id # 更新市场(部分更新)
DELETE /api/markets/:id # 删除市场
# Query parameters for filtering
# 用于过滤的查询参数
GET /api/markets?status=active&limit=10&offset=0
```
### Response Format
### 响应格式(Response Format
```typescript
// ✅ GOOD: Consistent response structure
// ✅ 推荐:一致的响应结构
interface ApiResponse<T> {
success: boolean
data?: T
@@ -256,26 +256,26 @@ interface ApiResponse<T> {
}
}
// Success response
// 成功响应
return NextResponse.json({
success: true,
data: markets,
meta: { total: 100, page: 1, limit: 10 }
})
// Error response
// 错误响应
return NextResponse.json({
success: false,
error: 'Invalid request'
}, { status: 400 })
```
### Input Validation
### 输入验证(Input Validation
```typescript
import { z } from 'zod'
// ✅ GOOD: Schema validation
// ✅ 推荐:Schema 验证
const CreateMarketSchema = z.object({
name: z.string().min(1).max(200),
description: z.string().min(1).max(2000),
@@ -288,7 +288,7 @@ export async function POST(request: Request) {
try {
const validated = CreateMarketSchema.parse(body)
// Proceed with validated data
// 使用验证后的数据继续执行
} catch (error) {
if (error instanceof z.ZodError) {
return NextResponse.json({
@@ -301,68 +301,68 @@ export async function POST(request: Request) {
}
```
## File Organization
## 文件组织(File Organization
### Project Structure
### 项目结构
```
src/
├── app/ # Next.js App Router
│ ├── api/ # API routes
│ ├── markets/ # Market pages
│ └── (auth)/ # Auth pages (route groups)
├── components/ # React components
│ ├── ui/ # Generic UI components
│ ├── forms/ # Form components
│ └── layouts/ # Layout components
├── hooks/ # Custom React hooks
├── lib/ # Utilities and configs
│ ├── api/ # API clients
│ ├── utils/ # Helper functions
│ └── constants/ # Constants
├── types/ # TypeScript types
└── styles/ # Global styles
│ ├── api/ # API 路由
│ ├── markets/ # 市场相关页面
│ └── (auth)/ # 认证相关页面(路由分组)
├── components/ # React 组件
│ ├── ui/ # 通用 UI 组件
│ ├── forms/ # 表单组件
│ └── layouts/ # 布局组件
├── hooks/ # 自定义 React hooks
├── lib/ # 工具函数与配置
│ ├── api/ # API 客户端
│ ├── utils/ # 辅助函数
│ └── constants/ # 常量
├── types/ # TypeScript 类型定义
└── styles/ # 全局样式
```
### File Naming
### 文件命名
```
components/Button.tsx # PascalCase for components
hooks/useAuth.ts # camelCase with 'use' prefix
lib/formatDate.ts # camelCase for utilities
types/market.types.ts # camelCase with .types suffix
components/Button.tsx # 组件使用 PascalCase
hooks/useAuth.ts # Hook 使用 camelCase 并以 'use' 开头
lib/formatDate.ts # 工具函数使用 camelCase
types/market.types.ts # 类型定义使用 camelCase 并带 .types 后缀
```
## Comments & Documentation
## 注释与文档
### When to Comment
### 何时编写注释
```typescript
// ✅ GOOD: Explain WHY, not WHAT
// Use exponential backoff to avoid overwhelming the API during outages
// ✅ 推荐:解释“为什么”这样做,而不是“在做什么”
// 使用指数退避算法Exponential backoff),避免在服务中断期间使 API 过载
const delay = Math.min(1000 * Math.pow(2, retryCount), 30000)
// Deliberately using mutation here for performance with large arrays
// 此处故意使用变更Mutation以提高大型数组的处理性能
items.push(newItem)
// ❌ BAD: Stating the obvious
// Increment counter by 1
// ❌ 糟糕:陈述显而易见的事实
// 将计数器加 1
count++
// Set name to user's name
// 将名称设置为用户的名称
name = user.name
```
### JSDoc for Public APIs
### 公共 API 的 JSDoc
```typescript
/**
* Searches markets using semantic similarity.
* 使用语义相似度搜索市场。
*
* @param query - Natural language search query
* @param limit - Maximum number of results (default: 10)
* @returns Array of markets sorted by similarity score
* @throws {Error} If OpenAI API fails or Redis unavailable
* @param query - 自然语言搜索查询
* @param limit - 最大结果数量(默认:10
* @returns 按相似度得分排序的市场数组
* @throws {Error} 如果 OpenAI API 失败或 Redis 不可用时抛出错误
*
* @example
* ```typescript
@@ -374,34 +374,34 @@ export async function searchMarkets(
query: string,
limit: number = 10
): Promise<Market[]> {
// Implementation
// 实现代码
}
```
## Performance Best Practices
## 性能最佳实践(Performance Best Practices
### Memoization
### 记忆化(Memoization
```typescript
import { useMemo, useCallback } from 'react'
// ✅ GOOD: Memoize expensive computations
// ✅ 推荐:记忆化高开销的计算
const sortedMarkets = useMemo(() => {
return markets.sort((a, b) => b.volume - a.volume)
}, [markets])
// ✅ GOOD: Memoize callbacks
// ✅ 推荐:记忆化回调函数
const handleSearch = useCallback((query: string) => {
setSearchQuery(query)
}, [])
```
### Lazy Loading
### 懒加载(Lazy Loading
```typescript
import { lazy, Suspense } from 'react'
// ✅ GOOD: Lazy load heavy components
// ✅ 推荐:懒加载重型组件
const HeavyChart = lazy(() => import('./HeavyChart'))
export function Dashboard() {
@@ -413,64 +413,64 @@ export function Dashboard() {
}
```
### Database Queries
### 数据库查询
```typescript
// ✅ GOOD: Select only needed columns
// ✅ 推荐:仅选择需要的列
const { data } = await supabase
.from('markets')
.select('id, name, status')
.limit(10)
// ❌ BAD: Select everything
// ❌ 糟糕:选择所有列
const { data } = await supabase
.from('markets')
.select('*')
```
## Testing Standards
## 测试标准(Testing Standards
### Test Structure (AAA Pattern)
### 测试结构AAA 模式)
```typescript
test('calculates similarity correctly', () => {
// Arrange
test('正确计算相似度', () => {
// 安排(Arrange
const vector1 = [1, 0, 0]
const vector2 = [0, 1, 0]
// Act
// 执行(Act
const similarity = calculateCosineSimilarity(vector1, vector2)
// Assert
// 断言(Assert
expect(similarity).toBe(0)
})
```
### Test Naming
### 测试命名
```typescript
// ✅ GOOD: Descriptive test names
test('returns empty array when no markets match query', () => { })
test('throws error when OpenAI API key is missing', () => { })
test('falls back to substring search when Redis unavailable', () => { })
// ✅ 推荐:描述性的测试名称
test('当没有市场匹配查询时返回空数组', () => { })
test('当缺失 OpenAI API 密钥时抛出错误', () => { })
test('当 Redis 不可用时回退到子字符串搜索', () => { })
// ❌ BAD: Vague test names
test('works', () => { })
test('test search', () => { })
// ❌ 糟糕:模糊的测试名称
test('正常工作', () => { })
test('测试搜索', () => { })
```
## Code Smell Detection
## 代码异味检测(Code Smell Detection
Watch for these anti-patterns:
警惕以下反模式:
### 1. Long Functions
### 1. 过长函数
```typescript
// ❌ BAD: Function > 50 lines
// ❌ 糟糕:函数超过 50 行
function processMarketData() {
// 100 lines of code
// 100 行代码
}
// ✅ GOOD: Split into smaller functions
// ✅ 推荐:拆分为更小的函数
function processMarketData() {
const validated = validateData()
const transformed = transformData(validated)
@@ -478,38 +478,38 @@ function processMarketData() {
}
```
### 2. Deep Nesting
### 2. 过深嵌套
```typescript
// ❌ BAD: 5+ levels of nesting
// ❌ 糟糕:超过 5 层的嵌套
if (user) {
if (user.isAdmin) {
if (market) {
if (market.isActive) {
if (hasPermission) {
// Do something
// 执行操作
}
}
}
}
}
// ✅ GOOD: Early returns
// ✅ 推荐:卫语句(Early Returns
if (!user) return
if (!user.isAdmin) return
if (!market) return
if (!market.isActive) return
if (!hasPermission) return
// Do something
// 执行操作
```
### 3. Magic Numbers
### 3. 魔术数字(Magic Numbers
```typescript
// ❌ BAD: Unexplained numbers
// ❌ 糟糕:未解释的数字
if (retryCount > 3) { }
setTimeout(callback, 500)
// ✅ GOOD: Named constants
// ✅ 推荐:命名的常量
const MAX_RETRIES = 3
const DEBOUNCE_DELAY_MS = 500
@@ -517,4 +517,4 @@ if (retryCount > MAX_RETRIES) { }
setTimeout(callback, DEBOUNCE_DELAY_MS)
```
**Remember**: Code quality is not negotiable. Clear, maintainable code enables rapid development and confident refactoring.
**记住**:代码质量是不容妥协的。清晰、可维护的代码是实现快速开发和自信重构的基石。