google开源项目风格指南二 命名约定(C++)

命名规则具有一定随意性, 但相比按个人喜好命名, 一致性更重, 所以不管你怎么想, 规则总归是规则


1 通用命名规则

函数,变量,文件命名要有描述性,少用缩写 尽可能给出有描述性的命名,别心疼空间,让代码易于理解更加重要 不要用只有项目开发者才能理解的缩写 不要通过省略几个字母来缩写单词

警示实例:

int n; //不知所名,莫名其妙 int nerr; //奇怪的缩写 int n_comp_conns; //奇怪的缩写 int wgc_connections; //只有开发者才明白的缩写 int pc_reader; //pc可以有很多种解释 int cstmr_id; //删减了字母


2 文件命名

文件名称要全部小写, 可以包含下划线或者连字符,按照项目的约定选择,最好选择下划线 通常尽量让文件名更加明确 内联函数必须放在.h 文件中,如果内联函数比较短,可以直接放在.h中


3 类型命名

类型名称的每个单词首字母都使用大写,不包含下划线 所有的类型命名,类\结构体\类型定义\枚举使用相同的约定

类型命名实例:

class UrlTable {... class UrlTableTester { ... struct UrlTableTester { ... typedef hash_map<UrlTableProperties * ,string> PropertiesMap; enum UrlTableErrors { ...


4 变量命名

变量名一律小写 单词之间使用下划线连接 类的成员变量以下划线结尾,结构体不需要 对全局变量没有特别要求,但是少用为好,可以使用g_或者其他标志作为前缀,更好的区分局部变量

变量命名实例:

string table_name ; string tablename;


5 常量命名

在全局或者类里面的常量名称之前加k 除去开头的k之外的每个单词开头字母均使用大写

常量命名实例:

const int kDaysInAWeek = 7;


6 函数命名

常规函数使用大小写混合,每个单词的首字母大写,没有下划线 取值和设值函数则要求与变量名匹配 其他非常短小的内联函数名可以用小写字母,例如,如果在循环中调用这样的函数甚至都不用缓存其返回值,小写命名可以接受

常量命名实例:

常规函数 AddTableEntry() DeleteUrl() 如果函数出错的时候直接崩溃,可以在函数名加上OrDie,但函数本身必须集成在产品代码中,OpenFileDie()


7 名字空间命名

名字空间用小写字母命名,基于项目名称和目录结构

常量命名实例:

常规函数 AddTableEntry() DeleteUrl() 如果函数出错的时候直接崩溃,可以在函数名加上OrDie,但函数本身必须集成在产品代码中,OpenFileDie()

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

推荐阅读更多精彩内容

  • importUIKit classViewController:UITabBarController{ enumD...
    明哥_Young阅读 3,801评论 1 10
  • 1、引言 数据库设计过程中表、字段等的命名规范也算是设计规范的一部分,不过设计规范更多的是为了确保数据库设计的合理...
    SnowflakeCloud阅读 40,988评论 0 48
  • 开发cocoa框架、插件或者其它带公共API的可执行文件需要不同于应用开发一些方法和惯例。你的产品的主要客户是开发...
    酱油不爱醋阅读 1,637评论 0 4
  • 《善用时间》1 推荐序及序言 带着目的和疑问来读书: 什么是善用时间?就是合理利用 为什么善用时间? 善用时间的方...
    宽幸福阅读 375评论 0 0
  • 洪崖的洞前流淌着岁月的年华 年华在你的眼眸里流转 一眼眨碎在飞舞的流光
    泊客行阅读 160评论 0 0