欢迎查阅项目A的编码规范!本规范旨在确保代码的可读性、一致性和可维护性,所有贡献者必须遵守以下准则:
1. 代码风格 🧹
- 缩进:使用4个空格进行缩进,禁止使用Tab
- 括号:
if/for/while
语句的括号需与条件/循环在同一行 - 空格:运算符两侧保留单空格,如
var = 10
2. 命名规范 📌
- 变量名使用小写下划线分隔:
user_name
- 函数名采用小写下划线分隔:
calculate_total_price
- 类名使用帕斯卡命名法:
ProjectAController
3. 注释规范 🗣️
- 函数注释需包含:参数说明、返回值说明、异常抛出
- 关键逻辑添加行内注释,注释与代码间保留空格
- 示例:
# 计算用户积分,@param user_id: 用户唯一标识 def update_user_points(user_id): ...
4. 错误处理 ⚠️
- 所有异常需通过
try/except
块捕获 - 错误码使用
HTTPStatus
枚举,禁止自定义数字码 - 日志记录需包含文件名、函数名和行号:
logger.error("Error occurred", file=__file__, func=__func__, line=__line__)
如需了解更多贡献指南,请访问 /community-forum/resources/project-a/contributing-guidelines。