代码风格规范参考

一、代码规范

Java

• 《阿里巴巴Java开发手册》(github可以直接下载最新版PDF): https://github.com/alibaba/p3c
  • 《Java开发手册》泰山版 https://developer.aliyun.com/topic/java2020
• Java 文档注释 | 菜鸟教程

Python

• PEPs
• google/styleguide
  • Python语言规范

HTMl & CSS & JS

• 编码规范 by @mdo: http://codeguide.bootcss.com/
• 腾讯全端团队: http://alloyteam.github.io/CodeGuide/
• 百度WEB前端研发部 文档与源码编写风格 : fex-team/styleguide

Git

• Commit message 和 Change log 编写指南
• 优雅的提交你的 Git Commit Message

二、API 设计规范参考

• Google - API 设计指南

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

• Microsoft - 为微服务设计 API

• GitHub REST API

• RESTful 命名法则：驼峰命名法(serverAddress)，蛇形命名法(server_address)，脊柱命名法(server-address)

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

三、文档编写

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