本项目旨在建立一个清晰、高效的代码规范,以提升团队协作效率和代码质量。
语言风格
- 中文:本页面使用中文内容。
- English:If the path contains English style, this page will be generated in English.
规范内容
命名规范
- 类名、变量名、函数名等使用驼峰命名法(CamelCase)。
- 常量使用全大写命名法,单词之间用下划线分隔。
注释规范
- 每个函数和复杂逻辑块前要有注释说明其功能。
- 注释清晰、简洁,避免使用复杂的缩写。
代码格式
- 使用 4 个空格进行缩进,不要使用 Tab。
- 代码行长度不超过 80 个字符,必要时可使用换行。
版本控制
- 使用 Git 进行版本控制,遵循提交规范。
- 合并请求(Pull Request)时,确保代码质量。
代码审查
- 定期进行代码审查,发现问题及时解决。
- 审查时关注代码规范、安全性和性能。