高质量C+/C编程指南 页码,21/101 第3章命名规则 比较著名的命名规则当推Microsoft公司的“匈牙利”法,该命名规则的主要思想是“在变量和函 数名中加入前缀以增进人们对程序的理解”。例如所有的字符变量均以c为前缀,若是指针变量则追 加前缀p。如果一个变量由ppch开头,则表明它是指向字符指针的指针。 “匈牙利”法最大的缺点是烦琐,例如 int i,j,k; float x,y,Z; 倘若采用“匈牙利”命名规则,则应当写成 ntiI,J,ik;/前缀i表示int类型 f1 oat fX,fY,fZ:/前缀f表示f1oat类型 如此烦琐的程序会让绝大多数程序员无法忍受。 据考察,没有一种命名规则可以让所有的程序员赞同,程序设计教科书一般都不指定命名规则。 命名规则对软件产品而言并不是“成败悠关”的事,我们不要化太多精力试图发明世界上最好的命名 规则,而应当制定一种令大多数项目成员满意的命名规则,并在项目中贯彻实施。 3.1共性规则 本节论述的共性规则是被大多数程序员采纳的,我们应当在遵循这些共性规则的前提下,再扩充 特定的规则,如32节。 ● 【规则3-1-1】标识符应当直观且可以拼读,可望文知意,不必进行“解码”。 标识符最好采用英文单词或其组合,便于记忆和阅读。切忌使用汉语拼音来命名。程序中的英文 单词一般不会太复杂,用词应当准确。例如不要把CurrentValue写成NowValue。 ● 【规则3-l-2】标识符的长度应当符合“min-length&max-information”原则。 几十年前老ANSI C规定名字不准超过6个字符,现今的C+/C不再有此限制。一般来说,长名字能 更好地表达含义,所以函数名、变量名、类名长达十几个字符不足为怪。那么名字是否越长约好?不 见得!例如变量名maxval就比maxValueUntil0 verflow好用。单字符的名字也是有用的,常见的如 i,j,k,m,n,x,y,z等,它们通常可用作函数内的局部变量。 ● 【规则3-13】命名规则尽量与所采用的操作系统或开发工具的风格保持一致。 例如Windows应用程序的标识符通常采用“大小写”混排的方式,如AddChild。而Unix应用程序的 标识符通常采用“小写加下划线”的方式,如add child。别把这两类风格混在一起用。 ● 【规则3-1-4】程序中不要出现仅靠大小写区分的相似的标识符。 例如: int x,X; /变量x与X容易混淆 http://man.chinaunix.net/develop/c&c++/c/c.htm 2006-3-30
第3章 命名规则 比较 著名的命 名规则当 推Microsoft 公司 的“匈牙 利”法,该命名规则的 主要思想是“在变量和 函 数名 中加入前缀以增进人们对程序的 理解”。例 如所有的字符变量均以ch为前缀,若是指针变 量则 追 加前缀p。如果一个变量由ppch开头,则 表明它是指向字符指针的指针。 “匈牙利”法最大 的缺点是 烦琐,例如 int i, j, k; float x, y, z; 倘若采用“匈牙利”命名规则,则应当 写成 int iI, iJ, ik; // 前缀 i表示int类型 float fX, fY, fZ; // 前缀 f表示float 类型 如此烦琐的程序 会让绝大多数程序员无法忍受。 据考 察,没有一 种命名规则 可以让所 有的程序 员赞同,程序 设计 教科 书一般都不指定命 名规则 。 命名规则对 软件产品 而言并不是“成败悠关”的事,我们不要化太多精力试图发 明世界上最 好的命 名 规则, 而应当制定一种令大多 数项目成员满意的命名规则, 并在项目中贯彻实施。 3.1 共性规则 本节论述的共性规则 是被 大多 数程序 员采纳的,我们应当 在遵循这些共性规则的前 提下,再扩充 特定的规则, 如3.2节。 l 【规则 3-1-1 】标识符应当 直观且可以拼读,可望文知意,不必进行“解码”。 标识符 最好采用英文单 词或其组合 ,便于记忆和阅读。 切忌使用汉语拼音来命名。程序中的 英文 单词一般不会太复杂,用词应当准确。例如不要把CurrentValue 写成NowValue 。 l 【规则 3-1-2 】标识符的长 度应当符 合“min-length && max-information ”原则。 几十年前 老ANSI C 规定 名字不准超 过6个字符,现今的C++/C 不再有此限制。一般来说,长 名字能 更好地表达 含义,所以函数名、变 量名、类名长达十几个 字符不足为怪。那 么名 字是否越长约好?不 见得 ! 例 如变 量 名 maxval 就 比 maxValueUntilOverflow 好 用。单 字 符的 名 字 也 是有 用的, 常见 的 如 i,j,k,m,n,x,y,z 等,它们通常可用作函数内的局部变量。 l 【规则 3-1-3 】命名规则尽量与所采用的操作系统或开发工具 的风格保持一致。 例如Windows 应用程序的标识符 通常采用“大小 写”混排的方式,如AddChild 。而Unix应用程序的 标识符 通常采用“小写加下划线”的方式,如add_child 。别把这两类风格混在一起用。 l 【规则 3-1-4 】程序中 不要出现仅靠大小写区分的相似的标识符 。 例如: int x, X; // 变量x 与 X 容易混淆 高质量C++/C编程指南 页码,21/101 http://man.chinaunix.net/develop/c&c++/c/c.htm 2006-3-30
高质量C+/C编程指南 页码,22/101 void foo(int x);/ 函数foo与F00容易混淆 void F00(float x); ● 【规则3-15】程序中不要出现标识符完全相同的局部变量和全局变量,尽管两者的作用域不同而 不会发生语法错误,但会使人误解。 ● 【规则3-1-6】变量的名字应当使用“名词”或者“形容词十名词”。 例如: float value; float oldValue; float newValue; ● 【规则317】全局函数的名字应当使用“动词”或者“动词+名词”(动宾词组)。类的成员函 数应当只使用“动词”,被省略掉的名词就是对象本身。 例如: DrawBox(); ∥全局函数 box->Draw():∥类的成员函数 ● 【规则3-1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。 例如: int minValue; int maxValue: int SetValue(...); int GetValue(...); 【建议3-1-1】尽量避免名字中出现数字编号,如Valuel,Value?2等,除非逻辑上的确需要编号。 这是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名字(因为用数字编号最省 事)。 3.2简单的Windows应用程序命名规则 作者对“匈牙利”命名规则做了合理的简化,下述的命名规则简单易用,比较适合于Windows应用 软件的开发。 ● 【规则32-1】类名和函数名用大写字母开头的单词组合而成。 例如: class Node; /1类名 class LeafNode; /1类名 void Draw(void); //函数名 http://man.chinaunix.net/develop/c&c++/c/c.htm 2006-3-30
void foo(int x); // 函数foo 与FOO容易混淆 void FOO(float x); l 【规则 3-1-5 】程序中 不要出现标识符完 全相同的局部变 量和全局变量,尽管两者的作用 域不同而 不会发生语法错误, 但会使人误解。 l 【规则 3-1-6 】变量的名字应当使用“名词”或者“形容词+名词”。 例如: float value; float oldValue; float newValue; l 【规则 3-1-7 】全局函数 的名字应当使用“动词”或者“动词+ 名词”(动宾词组)。类的成 员函 数应当只使用“动词”,被省略掉的名词就是对象本身。 例如: DrawBox(); // 全局函数 box->Draw(); // 类的成 员函数 l 【规则 3-1-8 】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。 例如: int minValue; int maxValue; int SetValue( …); int GetValue( …); ² 【建议 3-1-1 】尽量避免名字中出现数 字编号,如Value1,Value2 等,除非逻辑 上的确需要 编号。 这是为了 防止程序 员偷懒 ,不肯为命名动 脑筋而导致产生无意义的 名字(因为用数字编号最省 事)。 3.2 简单的Windows 应用程序命名规则 作者对 “匈牙利”命名规则做了合理的简化,下述的命名规则简单 易用,比较适合于Windows 应用 软件的开发。 l 【规则 3-2-1 】类名和函数名 用大写字母开头的单 词组合而成。 例如: class Node; // 类名 class LeafNode; // 类名 void Draw(void); // 函数名 高质量C++/C编程指南 页码,22/101 http://man.chinaunix.net/develop/c&c++/c/c.htm 2006-3-30
高质量C++/C编程指南 页码,23/101 void SetValue(int value);/ 函数名 ● 【规则3-2-2】变量和参数用小写字母开头的单词组合而成。 例如: BOOL flag; int drawMode; ● 【规则3-2-3】常量全用大写的字母,用下划线分割单词。 例如: const int MAX 100; const int MAX_LENGTH 100: ● 【规则3-2-4】静态变量加前缀s(表示static)。 例如: void Init(...) static int s initValue,∥静态变量 ● 【规则3-2-5】如果不得己需要全局变量,则使全局变量加前缀g(表示global)。 例如: intg_howManyPeople;∥全局变量 intg_howMuchMoney;∥全局变量 ● 【规则3-2-6】类的数据成员加前缀m(表示member),这样可以避免数据成员与成员函数的参 数同名。 例如: void Object::SetValue(int width,int height) m width width; m height height; ● 【规则32-7】为了防止某一软件库中的一些标识符和其它软件库中的冲突,可以为各种标识符加 上能反映软件性质的前缀。例如三维图形标准OpenGL的所有库函数均以gl开头,所有常量(或宏 定义)均以GL开头。 3.3简单的Unix应用程序命名规则 http://man.chinaunix.net/develop/c&c++/c/c.htm 2006-3-30
void SetValue(int value); // 函数名 l 【规则 3-2-2 】变量和参 数用小写字母开头的单 词组合而成。 例如: BOOL flag; int drawMode; l 【规则 3-2-3 】常量全用大写的字母,用下划线分割单词。 例如: const int MAX = 100; const int MAX_LENGTH = 100; l 【规则 3-2-4 】静态变量加前缀s_(表示static )。 例如: void Init( …) { static int s_initValue; // 静态变量 … } l 【规则 3-2-5 】如果不得已需要全局变量,则 使全局变量加前缀g_(表示global )。 例如: int g_howManyPeople; // 全局变量 int g_howMuchMoney; // 全局变量 l 【规则 3-2-6 】类的 数据成员加前缀m_(表示member ),这样可以避免数据成员与成 员函数 的参 数同名。 例如: void Object::SetValue(int width, int height) { m_width = width; m_height = height; } l 【规则 3-2-7 】为了 防止某一软件库中的一些标识符和 其它软件库中的冲突,可以为各种标识符 加 上能反映软件性质的前 缀。例 如三维图形标准OpenGL 的所有库函数 均以gl开头,所有常 量(或宏 定义)均以GL开头。 3.3 简单的Unix应用程序命名规则 高质量C++/C编程指南 页码,23/101 http://man.chinaunix.net/develop/c&c++/c/c.htm 2006-3-30
高质量C++/C编程指南 页码,24/101 http://man.chinaunix.net/develop/c&c++/c/c.htm 2006-3-30
高质量C++/C编程指南 页码,24/101 http://man.chinaunix.net/develop/c&c++/c/c.htm 2006-3-30
高质量C+/C编程指南 页码,25/101 第4章表达式和基本语句 读者可能怀疑:连if、for、while、goto、switch这样简单的东西也要探讨编程风格,是不是小 题大做? 我真的发觉很多程序员用隐含错误的方式写表达式和基本语句,我自己也犯过类似的错误。 表达式和语句都属于C+/C的短语结构语法。它们看似简单,但使用时隐患比较多。本章归纳了正 确使用表达式和语句的一些规则与建议。 4.1运算符的优先级 C+/C语言的运算符有数十个,运算符的优先级与结合律如表4-1所示。注意一元运算符+·*的 优先级高于对应的二元运算符。 优先级 运算符 结合律 ()[]> 从左至右 (类型)sizeof 从右至左 从 +-*& */% 从左至右 高 +- 从左至右 <<>> 从左至右 到 <<=>>= 从左至右 == 从左至右 低 & 从左至右 A 从左至右 排 从左至右 && 从左至右 列 从右至左 从右至左 =+==*==%=&== 从左至右 <<=>>= 表4-】运算符的优先级与结合律 ● 【规则41-1】如果代码行中的运算符比较多,用括号确定表达式的操作顺序,避免使用默认的优 先级。 由于将表41熟记是比较困难的,为了防止产生歧义并提高可读性,应当用括号确定表达式的操作 顺序。例如: word=(high <<8)|low http://man.chinaunix.net/develop/c&c++/c/c.htm 2006-3-30
第4章 表达式和基本语句 读者可能怀疑:连if、for、while 、goto、switch 这样简单的 东西 也要探讨编程 风格,是不是小 题大做? 我真的发觉很多程序员用隐含错误的 方式写表达式和基本语句,我自己也犯过类似的错误 。 表达 式和 语句 都属于C++/C 的短语结构 语法。它们看 似简单, 但使用时隐患比较 多。本章归纳 了正 确使用表达式和语句的一些规则与 建议。 4.1 运算符的优先级 C++/C 语言 的运算 符有数 十个,运算 符的 优先级 与结 合律如表 4-1所示。注意一元运算 符 + - * 的 优先级 高于对应的 二元运算符。 表4-1 运算符的优先级 与结 合律 l 【规则 4-1-1 】如果代码 行中的运算符比较多, 用括号 确定表达式的操作顺序,避免使用默认的优 先级。 由于将表4-1熟记是比较 困难的,为了 防止产生歧义并提高可读性,应当用 括号 确定表达 式的 操作 顺序。例如: word = (high << 8) | low 优先级 运算符 结合律 从 高 到 低 排 列 ( ) [ ] -> . 从左至右 ! ~ ++ -- (类型) sizeof + - * & 从右至左 * / % 从左至右 + - 从左至右 << >> 从左至右 < <= > >= 从左至右 == != 从左至右 & 从左至右 ^ 从左至右 | 从左至右 && 从左至右 || 从右至左 ?: 从右至左 = += -= *= /= %= &= ^= |= <<= >>= 从左至右 高质量C++/C编程指南 页码,25/101 http://man.chinaunix.net/develop/c&c++/c/c.htm 2006-3-30