編碼標準與最佳實務
跨專案通用的基本編碼慣例。
此技能是共享的基礎規範，而非詳細的框架手冊。
- 使用
frontend-patterns處理 React、狀態、表單、渲染與 UI 架構。 - 使用
backend-patterns或api-design處理儲存庫/服務層、端點設計、驗證與伺服器特定議題。 - 若只需要最簡潔的可重複使用規則層，而非完整的技能逐步解說，請使用
rules/common/coding-style.md。
啟用時機
- 啟動新專案或模組時
- 審查程式碼的品質與可維護性時
- 重構現有程式碼以符合慣例時
- 強制執行命名、格式化或結構一致性時
- 設定 linting、格式化或型別檢查規則時
- 引導新貢獻者了解編碼慣例時
範圍界限
啟用此技能以處理：
- 描述性命名
- 預設不可變性
- 可讀性、KISS、DRY 與 YAGNI 的強制執行
- 錯誤處理期望與程式碼異味審查
請勿將此技能當作下列領域的主要來源：
- React 組合、hooks 或渲染模式
- 後端架構、API 設計或資料庫分層
- 領域特定的框架指引，當已有更精確的 ECC 技能存在時
程式碼品質原則
1. 可讀性優先
- 程式碼被閱讀的次數遠多於撰寫的次數
- 清晰易懂的變數與函式名稱
- 偏好自我說明的程式碼，而非註解
- 一致的格式化
2. KISS（保持簡單，笨蛋）
- 使用最簡單且能正常運作的解決方案
- 避免過度工程化
- 不做過早最佳化
- 易於理解勝過巧妙程式碼
3. DRY（避免重複）
- 將共同邏輯抽取成函式
- 建立可重複使用的元件
- 跨模組共享工具程式
- 避免複製貼上編寫方式
4. YAGNI（你不需要它）
- 不要在需要之前就建構功能
- 避免投機的通用設計
- 僅在必要時增加複雜度
- 從簡單開始，需要時重構
TypeScript/JavaScript 標準
變數命名
// 通過：良好：描述性名稱
const marketSearchQuery = 'election'
const isUserAuthenticated = true
const totalRevenue = 1000
// 失敗：不良：不明確的名稱
const q = 'election'
const flag = true
const x = 1000
函式命名
// 通過：良好：動詞-名詞模式
async function fetchMarketData(marketId: string) { }
function calculateSimilarity(a: number[], b: number[]) { }
function isValidEmail(email: string): boolean { }
// 失敗：不良：不明確或僅有名詞
async function market(id: string) { }
function similarity(a, b) { }
function email(e) { }
不可變性模式（重要）
// 通過：一律使用展開運算子
const updatedUser = {
...user,
name: 'New Name'
}
const updatedArray = [...items, newItem]
// 失敗：絕不直接變更
user.name = 'New Name' // 不良
items.push(newItem) // 不良
錯誤處理
// 通過：良好：全面的錯誤處理
async function fetchData(url: string) {
try {
const response = await fetch(url)
if (!response.ok) {
throw new Error(`HTTP ${response.status}: ${response.statusText}`)
}
return await response.json()
} catch (error) {
console.error('Fetch failed:', error)
throw new Error('Failed to fetch data')
}
}
// 失敗：不良：無錯誤處理
async function fetchData(url) {
const response = await fetch(url)
return response.json()
}
非同步/等待最佳實務
// 通過：良好：盡可能並行執行
const [users, markets, stats] = await Promise.all([
fetchUsers(),
fetchMarkets(),
fetchStats()
])
// 失敗：不良：非必要時序列執行
const users = await fetchUsers()
const markets = await fetchMarkets()
const stats = await fetchStats()
型別安全
// 通過：良好：適當的型別
interface Market {
id: string
name: string
status: 'active' | 'resolved' | 'closed'
created_at: Date
}
function getMarket(id: string): Promise<Market> {
// 實作
}
// 失敗：不良：使用 'any'
function getMarket(id: any): Promise<any> {
// 實作
}
React 最佳實務
元件結構
// 通過：良好：函數式元件搭配型別
interface ButtonProps {
children: React.ReactNode
onClick: () => void
disabled?: boolean
variant?: 'primary' | 'secondary'
}
export function Button({
children,
onClick,
disabled = false,
variant = 'primary'
}: ButtonProps) {
return (
<button
onClick={onClick}
disabled={disabled}
className={`btn btn-${variant}`}
>
{children}
</button>
)
}
// 失敗：不良：無型別，結構不明確
export function Button(props) {
return <button onClick={props.onClick}>{props.children}</button>
}
自訂 Hooks
// 通過：良好：可重複使用的自訂 hook
export function useDebounce<T>(value: T, delay: number): T {
const [debouncedValue, setDebouncedValue] = useState<T>(value)
useEffect(() => {
const handler = setTimeout(() => {
setDebouncedValue(value)
}, delay)
return () => clearTimeout(handler)
}, [value, delay])
return debouncedValue
}
// 使用方式
const debouncedQuery = useDebounce(searchQuery, 500)
狀態管理
// 通過：良好：適當的狀態更新
const [count, setCount] = useState(0)
// 基於前一個狀態進行函數式更新
setCount(prev => prev + 1)
// 失敗：不良：直接引用狀態
setCount(count + 1) // 在非同步情境中可能過時
條件式渲染
// 通過：良好：清晰的條件式渲染
{isLoading && <Spinner />}
{error && <ErrorMessage error={error} />}
{data && <DataDisplay data={data} />}
// 失敗：不良：三元運算子地獄
{isLoading ? <Spinner /> : error ? <ErrorMessage error={error} /> : data ? <DataDisplay data={data} /> : null}
API 設計標準
REST API 慣例
GET /api/markets # 列出所有市場
GET /api/markets/:id # 取得特定市場
POST /api/markets # 建立新市場
PUT /api/markets/:id # 更新市場（完整）
PATCH /api/markets/:id # 更新市場（部分）
DELETE /api/markets/:id # 刪除市場
# 查詢參數用於篩選
GET /api/markets?status=active&limit=10&offset=0
回應格式
// 通過：良好：一致的回應結構
interface ApiResponse<T> {
success: boolean
data?: T
error?: string
meta?: {
total: number
page: number
limit: number
}
}
// 成功回應
return NextResponse.json({
success: true,
data: markets,
meta: { total: 100, page: 1, limit: 10 }
})
// 錯誤回應
return NextResponse.json({
success: false,
error: 'Invalid request'
}, { status: 400 })
輸入驗證
import { z } from 'zod'
// 通過：良好：Schema 驗證
const CreateMarketSchema = z.object({
name: z.string().min(1).max(200),
description: z.string().min(1).max(2000),
endDate: z.string().datetime(),
categories: z.array(z.string()).min(1)
})
export async function POST(request: Request) {
const body = await request.json()
try {
const validated = CreateMarketSchema.parse(body)
// 使用驗證後的資料繼續處理
} catch (error) {
if (error instanceof z.ZodError) {
return NextResponse.json({
success: false,
error: 'Validation failed',
details: error.issues
}, { status: 400 })
}
}
}
檔案組織
專案結構
src/
├── app/ # Next.js App Router
│ ├── api/ # API 路由
│ ├── markets/ # 市場頁面
│ └── (auth)/ # 驗證頁面（路由群組）
├── components/ # React 元件
│ ├── ui/ # 通用 UI 元件
│ ├── forms/ # 表單元件
│ └── layouts/ # 版面元件
├── hooks/ # 自訂 React hooks
├── lib/ # 工具與設定
│ ├── api/ # API 客戶端
│ ├── utils/ # 輔助函式
│ └── constants/ # 常數
├── types/ # TypeScript 型別
└── styles/ # 全域樣式
檔案命名
components/Button.tsx # PascalCase 用於元件
hooks/useAuth.ts # camelCase 並加上 'use' 前綴
lib/formatDate.ts # camelCase 用於工具
types/market.types.ts # camelCase 並加上 .types 後綴
註解與文件
何時加入註解
// 通過：良好：解釋「為什麼」而非「做什麼」
// 使用指數退避以避免在服務中斷期間對 API 造成負擔
const delay = Math.min(1000 * Math.pow(2, retryCount), 30000)
// 為提升大型陣列效能而刻意使用變更
items.push(newItem)
// 失敗：不良：陳述顯而易見的事實
// 將計數器加 1
count++
// 將名稱設為使用者的名稱
name = user.name
公開 API 的 JSDoc
/**
* 使用語意相似度搜尋市場。
*
* @param query - 自然語言搜尋查詢
* @param limit - 最大結果數量（預設：10）
* @returns 按相似度分數排序的市場陣列
* @throws {Error} 若 OpenAI API 失敗或 Redis 不可用
*
* @example
* ```typescript
* const results = await searchMarkets('election', 5)
* console.log(results[0].name) // "Trump vs Biden"
* ```
*/
export async function searchMarkets(
query: string,
limit: number = 10
): Promise<Market[]> {
// 實作
}
效能最佳實務
記憶化
import { useMemo, useCallback } from 'react'
// 通過：良好：記憶化耗費計算的運算
// 排序前複製 - Array.prototype.sort 會原地變更
const sortedMarkets = useMemo(() => {
return [...markets].sort((a, b) => b.volume - a.volume)
}, [markets])
// 通過：良好：記憶化回呼
const handleSearch = useCallback((query: string) => {
setSearchQuery(query)
}, [])
延遲載入
import { lazy, Suspense } from 'react'
// 通過：良好：延遲載入重量級元件
const HeavyChart = lazy(() => import('./HeavyChart'))
export function Dashboard() {
return (
<Suspense fallback={<Spinner />}>
<HeavyChart />
</Suspense>
)
}
資料庫查詢
// 通過：良好：僅選取需要的欄位
const { data } = await supabase
.from('markets')
.select('id, name, status')
.limit(10)
// 失敗：不良：選取所有欄位
const { data } = await supabase
.from('markets')
.select('*')
測試標準
測試結構（AAA 模式）
test('calculates similarity correctly', () => {
// Arrange（安排）
const vector1 = [1, 0, 0]
const vector2 = [0, 1, 0]
// Act（執行）
const similarity = calculateCosineSimilarity(vector1, vector2)
// Assert（斷言）
expect(similarity).toBe(0)
})
測試命名
// 通過：良好：描述性的測試名稱
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('works', () => { })
test('test search', () => { })
程式碼異味檢測
留意這些反模式：
1. 過長的函式
// 失敗：不良：函式超過 50 行
function processMarketData() {
// 100 行程式碼
}
// 通過：良好：拆分成較小的函式
function processMarketData() {
const validated = validateData()
const transformed = transformData(validated)
return saveData(transformed)
}
2. 深層巢狀結構
// 失敗：不良：5 層以上的巢狀
if (user) {
if (user.isAdmin) {
if (market) {
if (market.isActive) {
if (hasPermission) {
// 執行某些操作
}
}
}
}
}
// 通過：良好：提前返回
if (!user) return
if (!user.isAdmin) return
if (!market) return
if (!market.isActive) return
if (!hasPermission) return
// 執行某些操作
3. 魔術數字
// 失敗：不良：未經說明的數字
if (retryCount > 3) { }
setTimeout(callback, 500)
// 通過：良好：具名常數
const MAX_RETRIES = 3
const DEBOUNCE_DELAY_MS = 500
if (retryCount > MAX_RETRIES) { }
setTimeout(callback, DEBOUNCE_DELAY_MS)
請記住：程式碼品質無妥協空間。清晰、可維護的程式碼能加速開發並讓重構更有信心。