下面是项目老大列出的一些c++代码规范,感觉一个好的代码规范对自己的代码成长还是很重要的,希望对大家有用。
简单列几条代码规范:
文件命名:文件名使用小写英文单词加连字符如:content_classify.h
类名、函数名使用“驼峰”命名法如:class ContentClassify;
int SplitWords();
类成员变量使用英 文小写加连字符并下划线结尾如:uint64_t tag_;
Vim tab 替换为4个空白 (.vimrc set tabstop=4)
类、函数 “{” 顶头写: class ContentClassify {
行缩进为4个空白符
函数参数控制在5个以内
函数参数尽量使用const & 修饰
对成员变量不做些该只读的函数要加const修饰
函数行数控制在30行(尽量在一屏,不上下滚动)
一行代码控制在80个字符之内,超出要换行(保持在一屏之内,不横向移动)
代码嵌套层次控制在3层之内,不易过深。
尽量减少动态内存分配,预估运行过程中内存使用量,在初始化时分配好。
不要“复制”代码,如果代码在多处调用封装成函数、或类。
代码提交到git之前,要经过测试,代码行数改动较多,或重要的核心功能要找人review。
Git commit –m message message不能为空,必须填入有意义的内容,如:修改了那些bug,添加了什么文件等等。要填写英文内容,不要写入中文。