C++命名规则

前言

在初学C++的时候,一定要养成良好的命名习惯才可以让程序的可读性大大提高,这里我整理和收集了一些有用的命名规则,以便自己 后续程序阅读和分享。其中一些摘自网络,将比较常识性的东西去掉了,保留了自认为有价值的一些内容。

变量命名

变量或者函数的命名通常有一些准则可供参考,这里仅仅罗列了比较有用的一些:

准则 描述
最小长度原则 语意明确情况下,应当缩短命名长度
不重命名 在不同作用域中尽量不适用相同的命名
避免出现数字符号 避免名字中出现数字符号


变量名称由作用域+类型前缀+一个或者多个单词组成

作用域前缀

作用域前缀的常见写法如下:

前缀 说明
局部变量
m_ 类的成员
sm_ 静态类的成员
s_ 静态成员
g_ 外部全局变量
sg_ 外部静态全局变量
gg_ 进程间共享的全局变量

其中:除非不得已,尽可能少用全局变量

类型前缀

普通类型

普通类型是我们常见的一些数据类型,没有经过自定义

前缀 说明 关键词 示例
n 整形和位域变量 number int nCode
e 枚举变量 enum emum type eColor
c 字符型变量 char char cName
sz C类型字符串 char * char * szTemp[10]
cs CString字符串 CString CString csStr()
b 布尔类型变量 bool bool bFlag
f 浮点数据 float float fNumber
p 指针变量和迭代器 pointer Log* pLog
pfn 指向函数的指针变量,函数对象指针 pointer of function 待定
g 数组 grid/Array int gNumList[]
i 类的实例 instance Log iLog
h 句柄类型 HANDLE m_hWnd
- - - -
str 字符串 std::string std::string strName
v vector std::vector std::vector vTestItem

类型前缀可以使用组合方式,如vnNumList="vector int NumList"

枚举类型

枚举类型全部使用大写字母,并且最后一个字母为E

//LIMIT_CHECK_TYPE_E 上下限类型,E代表枚举
enum LIMIT_CHECK_TYPE_E
{
  LIMIT_NONE,
  LIMIT_LOWER_ONLY,
  LIMIT_UPPER_ONLY,
  LIMIT_BOTH,
};

结构体

结构体中,变量最后一个字母使用_T表示

CAMERA_BLEMISH_CONFIG_T{
}

类命名

属性命名

参考作用域前缀 部分

前缀 说明
局部变量
m_ 类的成员

方法命名

范围不同,方法前增加的下划线长度不同,这里是以前不曾注意到的点

类别 描述
函数命名 函数的名称由一个或者多个单词组成,每个单词首字母大写
保护成员(Protected) 保护成员函数应当加上一个“_"以便区别,如_SetValue()
私有成员 私有成员添加两个下划线,如__GetValue()
虚函数 虚函数习惯以“Do”开头,_DoEncryption
回调和事件处理函数 回调和事件处理函数以On开头,如__OnTimer()

常量命名

常量命名由类型前缀+全部大写组成,单词通过下划线(_)来进行分隔
nMAX_BUFFER,cMY_NAME

注释

完整注释

/*************************************************
Function:       PortUI::OnInitDlg() 
Description:    用于初始化界面的List.
Parameter:      Dlg的引用  HWND MainWnd。
Time:          20170831
Author:        LiangYaoting
*************************************************/

简短注释

//20170831 LYT 初始化界面
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 195,719评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,337评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 142,887评论 0 324
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,488评论 1 266
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,313评论 4 357
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,284评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,672评论 3 386
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,346评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,644评论 1 293
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,700评论 2 312
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,457评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,316评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,706评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,261评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,648评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,859评论 2 335

推荐阅读更多精彩内容