欢迎查阅 project-a 项目组的代码规范文档!我们致力于通过统一的编码标准提升代码可读性、可维护性,并确保团队协作效率。以下是核心规范内容:
📌 语言规范(默认中文)
命名规范
- 变量名使用
snake_case
,如user_name
- 函数名使用
camelCase
,如calculateTotalPrice
- 常量名全大写,如
MAX_RETRIES
- 类名使用
PascalCase
,如ProjectAController
- 变量名使用
格式要求
- 使用 4 空格缩进,严格遵循 PEP8 规则
- 每行不超过 79 个字符,长代码需用
\
换行 - 注释需用中文描述,关键逻辑需添加英文注释(如
// Avoid null reference
)
安全实践
- 所有输入需进行校验(如
validateInput(data)
) - 敏感信息(如数据库密码)需通过
.env
文件配置 - 异常处理需记录日志(查看日志规范)
- 所有输入需进行校验(如
🛠 扩展阅读
通过遵循这些规范,您可以更好地融入 project-a 的开发流程。如需个性化配置,请联系项目负责人!