欢迎查阅本站的代码规范文档!为确保代码质量和团队协作效率,以下为通用开发规范建议:

📌 命名规范

  • 变量名:使用 camelCasesnake_case(根据语言习惯)
    • 示例:userName / user_name
  • 函数名:动词开头,如 calculateTotal()process_data()
  • 常量名:全大写 + 下划线,如 MAX_LIMIT = 100

🛠 代码结构

  1. 模块划分:按功能拆分模块,避免单一职责原则被打破
  2. 缩进格式:统一使用 4 个空格或 Tab(推荐 4 空格)
  3. 注释要求
    • 函数注释需包含用途、参数和返回值
    • 关键逻辑添加行内注释(❗避免过度注释)

🧪 安全实践

  • 输入验证:始终对用户输入进行过滤(🛡️防止注入攻击)
  • 密码处理:使用 bcryptargon2 加密(🔐推荐现代算法)
  • 错误处理:避免暴露敏感信息(🚫不要返回数据库错误详情)

📚 扩展阅读

如需深入了解代码规范,可参考:

Code_Quality
Naming_Conventions