一、代碼規范

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 的中文文檔排版規范