原创

C++常用命名法与书写规范

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://shazhenyu.blog.csdn.net/article/details/52327922

常用命名法有三种:

驼峰命名法匈牙利命名法帕斯卡命名法

 

这三种命名方法各有千秋,以庄子的齐物论来说就是“道无终始,物有死生,不恃其成”。我们要“吸百家之长,圆我代

码功夫”,废话说了几行了,综合出来的代码规范如下:

 

一、标识符

1、简单、合理、准确的英文单词(不要缩写),切忌汉语拼音。(eg:不要把CurrentWidth写出NowWidth)

2、不要仅靠大小写区分标识符

3、避免一个标识符多种定义、避免出现数字编号、避免在不同作用域重名

4、写库函数或接口开发时,增加库标识头

 

 

二、类型【限定符(const等)+修饰符(long等)+数据类型(int等)+指针(*)+成员变量名】

1、指针应该应该紧靠数据类型(eg:int* m_nWidth)

2、变量前缀:类的成员m_,静态变量s_,外部全局变量g_,静态全局变量sg_,共享全局变量gg_

3、类型前缀:bool--b,char--ch,int--n,long--l,float-f,double--d,指针-p,enum-e,数组--g

4、常量及宏定义:全部大写

 

三、结构 

1、if、for、switch等关键字独占一行,后面跟半个“{”,作用域结束用“}”,作用域内仅一条语句也这么写

if( m_nWidth == 19) {
    m_nWidth=20;
}

2、长行拆分(超过一般函数会折行显示)

3、对于算法较复杂的加小括号修饰

4、尽量减少多继承、尽量不使用操作符重载

 

四、函数 

1、操作系统风格:Windows风格--GetWidth()、Linux风格--get_width()(注:Qt风格--getWidth())

2、内联函数定义在头文件,inline关键字在最前(eg:inline int getWidth(){return m_nWidth;})

3、Qt的槽函数以on开头(eg:onGetWidth())

4、Qt的信号函数以sig开头(eg:sigClicked())

5、取值函数若只返回一个值或只有简单操作,后加const限定符。

6、为防止构造函数隐式转换,加explicit关键字

7、实现虚函数是,加virtual关键字明确函数类型

 

五、其他

1、注释、在代码的上边、右边、或结束位置,函数的注释写在头文件

2、结构体、联合体、枚举、类名的首字母大写

3、好的声明次序:typedefs和enums,常量,构造函数,析构函数,成员函数,数据成员

 

文章最后发布于: 2018-06-27 18:27:55
展开阅读全文

没有更多推荐了,返回首页

©️2019 CSDN 皮肤主题: 代码科技 设计师: Amelia_0503

分享到微信朋友圈

×

扫一扫,手机浏览