主页

索引

模块索引

搜索页面

2.1. 常用

非编码类规范

• 2.1.1. 常用
• 2.1.2. 开源规范
• 2.1.3. 文档规范
  • API 接口文档规范
• 2.1.4. 版本规范
  • 语义化版本SemVer
• 2.1.5. Commit 规范
  • Header
  • Body
  • Footer
  • Revert Commit
  • Commit 相关的 3 个重要内容
  • Commit Message 规范自动化
  • 实战
  • 参考
• 2.1.6. 发布规范

编码类规范

• 2.1.7. 目录结构规范
• 2.1.8. 代码规范
  • Makefile
  • 测试
  • 参考
• 2.1.9. 接口规范
  • RESTful API设计原则
  • RPC API
  • OpenAPI
• 2.1.10. 日志规范
  • 基础功能
  • 高级功能
  • 可选功能
  • 需要关注的点
  • 如何记录日志
  • 日志的 “最佳” 实践总结
• 2.1.11. 错误码规范
  • 常见的错误码设计方式
  • 业务 Code 码设计

其他

• 2.1.12. 研发流程
  • 标准的研发流程
  • 应用生命周期管理
  • 研发模式
  • CI/CD
  • DevOps
  • 如何选择合适的应用生命周期管理技术
• 2.1.13. 设计方法
  • 1. 代码结构
  • 2. 代码规范
  • 3. 代码质量
  • 4. 编程哲学
  • 5. 软件设计方法
• 2.1.14. 工作流规范
  • 集中式工作流
  • 功能分支工作流
  • Git Flow 工作流
  • Forking 工作流
  • 实践
• 2.1.15. SDK 规范

主页

索引

模块索引

搜索页面