代码规范

代码规范是保证代码质量和可维护性的基础。在AI辅助编程时代，建立清晰的代码规范变得更加重要。

最佳实践·预计阅读时间：45分钟

01概述

代码规范是一套统一的编码标准和最佳实践，帮助团队编写清晰、一致、可维护的代码。在AI辅助编程中，代码规范可以帮助AI生成更符合团队标准的代码，同时也便于审查和维护。

规范的重要性

提高可读性

统一的代码风格使代码更易阅读和理解

降低维护成本

规范的代码更易于维护和修改

促进协作

团队成员遵循相同规范，减少代码冲突

引导AI输出

通过Prompt明确规范，让AI生成符合标准的代码

02命名规范

良好的命名是代码可读性的基础。清晰、一致的命名可以让代码自解释，减少对注释的依赖。

命名规则

类型	命名风格	示例
变量	camelCase	userName, itemCount
常量	UPPER_SNAKE_CASE	MAX_RETRY, API_BASE_URL
函数	camelCase	getUserData, calculateTotal
类	PascalCase	UserService, DataValidator
接口	PascalCase + I前缀	IUserService, IRepository
文件	kebab-case	user-service.ts, api-client.js

AI生成代码命名

Prompt中指定命名规范

在Prompt中明确命名风格要求
提供命名示例供AI参考
使用团队命名词典
审查AI生成的命名是否符合规范

03代码结构

良好的代码结构是可维护性的关键。清晰的文件组织、合理的函数划分，让代码易于理解和修改。

文件结构

推荐文件结构

导入语句（外部依赖在前，内部模块在后）
常量定义
类型/接口定义
主要组件/类
辅助函数
导出语句

函数结构

单一职责原则

每个函数只做一件事，函数长度控制在30行以内

参数数量控制

参数不超过3-4个，超过时使用对象封装

避免深层嵌套

嵌套层级不超过3层，使用早返回减少嵌套

04注释规范

注释应该解释代码为什么这样做，而不是做了什么。好的注释可以提高代码的可维护性。

注释类型

类型	用途	示例
文档注释	API文档、类型说明	JSDoc、TSDoc
行内注释	解释复杂逻辑	// 单行说明
TODO注释	待办事项	// TODO: 优化性能
FIXME注释	已知问题	// FIXME: 边界情况

AI生成注释

注释质量检查

AI生成的注释可能不准确，需要人工验证

避免冗余注释

不要为自解释的代码添加注释

保持注释更新

代码修改时同步更新相关注释

05格式规范

统一的代码格式可以减少无意义的diff，提高代码审查效率。

格式项	推荐值
缩进	2空格或4空格（团队统一）
行宽	80-120字符
空行	函数之间1行，逻辑块之间1行
引号	统一使用单引号或双引号
分号	根据语言规范统一使用或不使用
尾逗号	多行时添加尾逗号

06自动化工具

使用自动化工具强制执行代码规范，减少人工检查的工作量。

工具类型	代表工具	功能
格式化	Prettier, Black	自动格式化代码
Linter	ESLint, Pylint	检查代码规范
类型检查	TypeScript, mypy	静态类型检查
Git Hook	husky, lint-staged	提交前检查

07最佳实践

1. 规范文档化

将团队规范整理成文档，便于查阅和新人培训

2. 自动化执行

使用工具自动检查和格式化，减少人工干预

3. Prompt集成规范

在AI编程Prompt中嵌入规范要求

4. 持续改进

根据项目需要定期更新和完善规范

AI编程规范要点

在AI辅助编程中，代码规范不仅是团队协作的基础，也是引导AI生成高质量代码的关键。通过在Prompt中明确规范要求，可以让AI输出更符合团队标准的代码。

← Prompt技巧

团队协作 →