google部分编程规范.pdf

google-cpp-styleguide 介绍 说明：此文内容来自google-cpp-styleguide 第6 章 第8 章 详细内容请参阅 google-cpp-styleguide，在此我们仅要求熟知第 6 章 第 8 章即可。 Table of Contents 1. 命名约定2 2. 格式9 1. 命名约定 最重要的一致性规则是命名管理. 命名风格快速获知名字代表是什么东东: 类型? 变量? 函 数? 常量? 宏 ... ? 甚至不需要去查找类型声明. 我们大脑中的模式匹配引擎可以非常可靠的 处理这些命名规则. 命名规则具有一定随意性, 但相比按个人喜好命名, 一致性更重, 所以不管你怎么想, 规则总 归是规则. 1.1. 通用命名规则 Tip 函数命名, 变量命名, 文件命名应具备描述性; 不要过度缩写. 类型和变量应该是名词, 函数名可以用 “命令性” 动词. 如何命名: 尽可能给出描述性的名称. 不要节约行空间, 让别人很快理解你的代码更重要. 好的命 名风格: int num_errors ; // Good. int num_completed_connections ; // Good. 糟糕的命名使用含糊的缩写或随意的字符: int n ; // Bad - meaningless. int nerr ; // Bad - ambiguous abbreviation. int n_comp_conns ; // Bad - ambiguous abbreviation. 类型和变量名一般为名词: 如 FileOpener, num_errors. 函数名通常是指令性的 (确切的说它们应该是命令), 如 OpenFile(), set_num_errors(). 取值函数是个特例 (在 函数命名 处详细阐述), 函数名和它要取 值的变量同名. 缩写: 除非该缩写在其它地方都非常普遍, 否则不要使用. 例如: // Good // These show proper names with no abbreviations. int num_dns_connections; // 大部分人都知道 DNS 是啥意思. int price_count_reader ; // OK, price count. 有意义. Warning // Bad! // Abbreviations can be confusing or ambiguous outside a small group. int wgc_connections ; // Only your group knows what this stands for. int pc_reader ; // Lots of things can be abbreviated pc. 永远不要用省略字母的缩写: int error_count; // Good. int error_cnt; // Bad. 1.2. 文件命名 Tip 文件名要全部小写, 可以包含下划线 (_) 或连字符 (-). 按项目约定来. 可接受的文件命名: my_useful_class.cc my-useful-class.cc myusefulclass.cc C++ 文件要以 .cc 结尾, 头文件以 .h 结尾. 不要使用已经存在于 /usr/include 下的文件名 (yospaly 注: 即编译器搜索系统头文件的 路径), 如 db.h. 通常应尽量让文件名更加明确. http_server_logs.h 就比 logs.h 要好. 定义类时文件名 一般成对出现,