Code-Style.md

规范

• 规范
  • 1 C++代码规范(Fellow Google)
  • 2 Git提交规范
  • 3 版本号管理
  • 4 API

1 C++代码规范(Fellow Google)

1. 源文件名/变量命名：小驼峰命名法，一般不使用缩写
2. 类名使用大驼峰命名法
3. 命名空间一律小写
4. 代码注释与文档使用Doxygen

参考Google C++ Style Guide
参考Google C++ Style Guide(cn)
参考doxygen/manual cpp

2 Git提交规范

1. 每个人在自己的分支开发，开发完成后自测，自测后提交。提交信息命名为add,fix,update，添加功能时使用add，修复bug时使用fix，更新已有功能时或不符合前两种时使用update

# 例如
git commit -m "fix http包长度bug"
git commit -m "add base64解码"
git commit -m "update 更新README.md"

# 推送到远程仓库
$ git push

2. 发起PR经Review之后合并入develop分支

3 版本号管理

1. 使用语义版本，版本号MAJOR.MINOR.PATCH

Version	Detial
MAJOR version	when you make incompatible API changes
MINOR version	when you add functionality in a backwards-compatible manner
PATCH version	when you make backwards-compatible bug fixes
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

4 API

Microsoft REST API Guidelines