代码部分

  • 分析boss需求，做需求文档，文档中英两份，在代码块中标注具体实现的需求
  • 变量命名暂时可以参考阿里巴巴Java命名规范，网址点此查看
  • 重复的代码需要提出进行封装为工具类、函数、或变量功能
  • 不可过度设计结构，确保项目可以让所有人接手和维护
  • 清晰的定义，干净的代码页面，代码不可冗杂
  • 清晰的目录结构与包名，按类名或文件命名进行分包管理
  • 排错，自我检测bug，修复所有隐患，修复所有逻辑bug

  • 使用git提交版本，工作日志与修复项

    Api文档部分

  • 需详细写明请求参数的数据类型、数据格式、可选与不可选返回结果

  • 需写明请求方式、地址、Http类型、code状态码定义
  • 需详细写明请求示例与返回结果
  • 需详细写明每个Api的内容与作用
  • 变更需邮件告知所有开发者
  • 中英双份，详细标注每个参数的定义，确保与需求文档内容一致，开发者一眼明目
  • 可参考此Api文档点此查看