Documentation
README
编码标准与最佳实践 (Coding Standards & Best Practices)
适用于所有项目的通用编码标准。
何时启用 (When to Activate)
- 启动新项目或模块时
- 为了质量和可维护性进行代码审查(Code Review)时
- 重构现有代码以遵循规范时
- 强制执行命名、格式或结构的一致性时
- 设置 linting、格式化或类型检查规则时
- 引导新贡献者了解编码规范时
代码质量原则 (Code Quality Principles)
1. 可读性优先 (Readability First)
- 代码被阅读的次数远多于编写的次数
- 变量和函数命名应清晰明确
- 优先选择自描述代码,而非依赖注释
- 保持一致的格式化风格
2. KISS 原则 (Keep It Simple, Stupid)
- 采用最简单的可行方案
- 避免过度设计(Over-engineering)
- 不进行过早优化
- 易于理解胜过奇技淫巧
3. DRY 原则 (Don't Repeat Yourself)
- 将公共逻辑提取为函数
- 创建可复用的组件
- 在模块间共享工具函数
- 避免“复制粘贴式”编程
4. YAGNI 原则 (You Aren't Gonna Need It)
- 不要在功能被需要之前就构建它
- 避免投机性的通用设计
- 仅在必要时增加复杂性
- 从简单开始,在需要时重构
TypeScript/JavaScript 规范
变量命名 (Variable Naming)
This is the opening of the README. Read the full README on GitHub.