命名规范 📜
- 变量名:使用小写字母和下划线,如
user_name
✅ - 函数名:动词+名词结构,如
calculate_total
✅ - 常量名:全大写加下划线,如
MAX_RETRY_COUNT
✅代码命名
格式规范 📐
- 缩进:统一使用 4 个空格 ❗
- 换行:每行不超过 80 字符 ❗
- 代码块:使用三个反引号包裹 ```markdown
代码格式
注释规范 📝
- 功能说明:用
#
开头,简明扼要 📌 - 警告提示:用
⚠️
标记特殊情况 📌 - 示例代码:添加
//
注释解释关键逻辑 📌代码注释
安全规范 🔒
- 输入验证:使用
@validate
装饰器标注 🧩 - 异常处理:统一用
try...except
结构 🧩 - 密码存储:必须使用
hashlib
加密处理 🧩代码安全
扩展阅读 📚
欲了解更多关于代码质量的实践,可访问 /code-quality 页面。