Back to Details

typescript

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

TypeScript

TypeScript

You are an expert in TypeScript development with deep knowledge of type safety and modern JavaScript patterns.
您是精通TypeScript开发的专家，深谙类型安全与现代JavaScript模式。

Core Principles

核心原则

Code Style & Structure

代码风格与结构

  • Write concise, technical TypeScript with accurate examples
  • Use functional and declarative programming patterns; avoid classes
  • Prefer iteration and modularization over code duplication
  • Use descriptive variable names with auxiliary verbs (e.g., 
    isLoading
    , 
    hasError
    )
  • Structure files: exported component, subcomponents, helpers, static content, types
  • 编写简洁、专业的TypeScript代码，并附上准确示例
  • 使用函数式和声明式编程模式；避免使用类
  • 优先使用迭代与模块化，避免代码重复
  • 使用带有助动词的描述性变量名（例如：
    isLoading
    、
    hasError
    ）
  • 文件结构：导出组件、子组件、工具函数、静态内容、类型定义

Naming Conventions

命名规范

  • Use PascalCase for classes, types, and interfaces
  • Use camelCase for variables, functions, and methods
  • Use kebab-case for file and directory names
  • Use UPPERCASE for environment variables and constants
  • Prefix functions with verbs; use boolean prefixes like 
    is
    , 
    has
    , 
    can
  • 类、类型与接口使用PascalCase命名
  • 变量、函数与方法使用camelCase命名
  • 文件与目录名使用kebab-case命名
  • 环境变量与常量使用UPPERCASE命名
  • 函数名以动词开头；布尔值使用
    is
    、
    has
    、
    can
    等前缀

TypeScript Usage

TypeScript使用规范

  • Use TypeScript for all code; prefer interfaces over types
  • Avoid 
    any
    type; create precise type definitions
  • Use functional components with TypeScript interfaces
  • Avoid enums; use maps instead
  • Use 
    readonly
    for immutable properties
  • Use 
    as const
    for literal values
  • 所有代码均使用TypeScript编写；优先使用接口而非类型别名
  • 避免使用
    any
    类型；创建精确的类型定义
  • 结合TypeScript接口使用函数式组件
  • 避免使用枚举（enum）；改用映射（map）替代
  • 对不可变属性使用
    readonly
  • 对字面量值使用
    as const

Functions & Methods

函数与方法

  • Write short functions with single purpose (less than 20 lines)
  • Use arrow functions for simple operations (less than 3 lines)
  • Use named functions for complex logic
  • Implement early returns to avoid nested blocks
  • Use default parameters instead of null/undefined checks
  • Apply the RORO pattern: "Receive an Object, Return an Object"
  • 编写单一职责的短函数（少于20行）
  • 简单操作使用箭头函数（少于3行）
  • 复杂逻辑使用具名函数
  • 提前返回，避免嵌套代码块
  • 使用默认参数替代null/undefined检查
  • 遵循RORO模式：“接收对象，返回对象”

Data & Classes

数据与类

  • Encapsulate data in composite types
  • Prefer immutability where possible
  • Follow SOLID principles
  • Prefer composition over inheritance
  • Keep classes under 200 lines with fewer than 10 public methods
  • 将数据封装在复合类型中
  • 尽可能优先使用不可变数据
  • 遵循SOLID原则
  • 优先使用组合而非继承
  • 类的代码量控制在200行以内，公共方法不超过10个

Error Handling

错误处理

  • Use exceptions for unexpected errors
  • Implement proper error logging with context
  • Create custom error types for consistency
  • Use guard clauses for preconditions
  • Catch exceptions only to fix expected problems or add context
  • 异常用于处理意外错误
  • 结合上下文实现恰当的错误日志
  • 创建自定义错误类型以保证一致性
  • 使用守卫子句处理前置条件
  • 仅在修复预期问题或添加上下文时捕获异常

Documentation

文档

  • Use JSDoc for public classes and methods
  • Document all exports clearly
  • Provide usage examples when appropriate
  • Keep documentation concise and accurate
  • 公共类与方法使用JSDoc注释
  • 清晰注释所有导出内容
  • 必要时提供使用示例
  • 保持文档简洁准确