📚 本文整理了常见编程规范的核心要点,点击 这里 查看实践案例

命名约定 💻

  • 变量/函数名:使用 lowerCamelCase(如 userName)或 snake_case(如 user_name
  • 常量:全大写加下划线(如 MAX_USERS
  • 类名PascalCase(如 UserManager
  • 示例图片 展示规范命名的代码对比

代码结构 📄

  • 每个函数保持单一职责(Single Responsibility Principle)
  • 使用空行分隔逻辑块,缩进统一为4个空格
  • 📌 架构图 展示模块化设计原则

注释规范 🛡️

  • 类注释:/** ... */ 描述功能与使用限制
  • 方法注释:说明参数含义与异常处理
  • 📌 示例图片 展示注释与代码的合理比例

安全实践 🔒

  • 输入校验:使用 isEmail() 等函数过滤非法数据
  • 密码处理:始终使用 bcryptargon2 加密
  • 📌 安全指南 展示防御性编程技巧

扩展阅读 📚