统一规范参考

如果大家都遵循一个统一规范, 将带来很多方便

• 《阿里巴巴Java开发手册》: https://github.com/alibaba/p3c

  • 《Java开发手册》泰山版 https://developer.aliyun.com/topic/java2020

• Java 文档注释 | 菜鸟教程

• 编码规范 by @mdo: http://codeguide.bootcss.com/

• 腾讯全端团队: http://alloyteam.github.io/CodeGuide/

• 百度WEB前端研发部 文档与源码编写风格 : fex-team/styleguide

• Commit message 和 Change log 编写指南

• 优雅的提交你的 Git Commit Message

二、API 设计规范参考

• Google - API 设计指南

  • 不能访问可参考 https://pantao.gitbooks.io/api-design-guide/content/)

• Microsoft - 为微服务设计 API

• GitHub REST API

• [问题1: ] HTTP 状态码和业务状态码如何配合使用?

三、文档编写

• Github GFM (GitHub Flavored Markdown Spec)
• 基于 Markdown 的中文文档排版规范

---

作者：小鸣的微笔记
出处：52liming.cnblogs.com
转载：文章可以转载，但是请标注原文链接
原文：https://www.cnblogs.com/52liming/p/8649421.html