C++编程习惯

一、命名规则

1.文件命名

文件名全部小写,可以含下划线或连字符,按项目约定命名,且尽量保证文件名明确。比如:

cmd_save_player_info_class.cpp                     my_use_full_class.cpp

定义类的文件名一般是成对出现,如:foo_bar.h  foo_bar.cpp

若是类中含大量内联函数,我们还可使用-ini.h文件,使之文件内容更加清晰,于是又如:

url_table.h url_table.cc url-table-ini.h

若文件用于定义和实现类,建议文件名与类名保持一致。

基于工程名,开头3个字母应表明与哪一个工程相关。
后面的字母应能够区别不同的功能。

2.类命名规则

类型命名每个单词首字母大写,不含下划线,以名词形式。比如: MyPalyerManager,这对于所有类型命名一样,类结构体,枚举,类定义都是如此,比如:MyExcitingEnum

C++类/结构的命名

类的名称都要以大写字母“C”开头,后跟一个或多个单词。为便于界定,每个单词的首字母要大写。

推荐的组成形式

类的命名推荐用"名词"或"形容词+名词"的形式,例如:"CAnalyzer", "CFastVector" ....

不同于C++类的概念,传统的C结构体只是一种将一组数据捆绑在一起的方式。传统C结构体的命名规则为:

传统C结构体的命名

传统C结构体的名称全部由大写字母组成,单词间使用下划线界定,例如:"SERVICE_STATUS", "DRIVER_INFO" ...

3.变量命名规则

变量名除第一个单词外,其他单词首字母大写。

类成员变量加前缀m_ ,全局变量加前缀g_,结构体成员变量与普通变量相同。

特殊:i、j、k作为循环变量,tmp作为临时变量。

当然结构体成员变量还是和普通变量一样,比如:string name; int num_entries;

变量的命名

变量名由作用域前缀+类型前缀+一个或多个单词组成。为便于界定,每个单词的首字母要大写。

对于某些用途简单明了的局部变量,也可以使用简化的方式,如:i, j, k, x, y, z ....

作用域前缀

作用域前缀标明一个变量的可见范围。作用域可以有如下几种:

前缀

说明

局部变量

m_

类的成员变量(member)

sm_

类的静态成员变量(static member)

s_

静态变量(static)

g_

外部全局变量(global)

sg_

静态全局变量(static global)

gg_

进程间共享的共享数据段全局变量(global global)

除非不得已,否则应该尽可能少使用全局变量。

类型前缀

类型前缀标明一个变量的类型,可以有如下几种:

前缀

说明

n

整型和位域变量(number)

e

枚举型变量(enumeration)

c

字符型变量(char)

b

布尔型变量(bool)

f

浮点型变量(float)

p

指针型变量和迭代子(pointer)

pfn

特别针对指向函数的指针变量和函数对象指针(pointer of function)

g

数组(grid)

i

类的实例(instance)

对于经常用到的类,也可以定义一些专门的前缀,如:std::string和std::wstring类的前缀可以定义为"st",std::vector类的前缀可以定义为"v"等等。

类型前缀可以组合使用,例如"gc"表示字符数组,"ppn"表示指向整型的指针的指针等等。

推荐的组成形式

变量的名字应当使用"名词"或者"形容词+名词"。例如:"nCode", "m_nState","nMaxWidth"" oldValue "," newValue "....

4.常量名命名规则

常量名由类型前缀+全大写字母组成,单词间通过下划线来界定,如:cDELIMITER, nMAX_BUFFER ....

类型前缀的定义与变量命名规则中的相同。

或者 k后面跟大写字母开头的单词,比如:

const int kDaysInAWeek=7;

const string kCompanyName=”Tecent”;

5.函数命名规则

常规函数每个单词首字母大写,使用命令式语气,比如:OpenFile() CheckFileName(),

而存取函数或短小的内联函数使用小写加下划线,且与访问变量相吻合,比如 set_num_errors();

class Player{ 
public: 
void set_player_id(const int player_id){return player_id_=player_id;} 
int get_player_id() const{return player-id_;} 
private: 
int palyer_id_; 
};

函数的命名

函数的名称由一个或多个单词组成。为便于界定,每个单词的首字母要大写。

推荐的组成形式

函数名应当使用"动词"或者"动词+名词"(动宾词组)的形式。例如:"GetName()", "SetValue()", "Erase()", "Reserve()" ....

保护成员函数

保护成员函数的开头应当加上一个下划线“_”以示区别,例如:"_SetState()" ....

私有成员函数

类似地,私有成员函数的开头应当加上两个下划线“__”,例如:"__DestroyImp()" ....

虚函数

虚函数习惯以“Do”开头,如:"DoRefresh()", "_DoEncryption()" ....

回调和事件处理函数

回调和事件处理函数习惯以单词“On”开头。例如:"_OnTimer()", "OnExit()" ....


6.名字空间命名

命名空间全小写,并基于项目名称和目录结构,比如

google_awesome_project

7.枚举命名规则

枚举类名属于类型名,按类命名,枚举值全大写加下划线,比如:ENUM_NAME 
8.宏变量命名规则

如果你一定要用到宏,全大写加下划线,比如:

define PI_ROUND 3.0

参考:http://www.cnblogs.com/S031602240/p/6820530.html#1

http://www.cnblogs.com/ggjucheng/archive/2011/12/15/2289291.html



  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值