码迷,mamicode.com
首页 > 其他好文 > 详细

命名规则

时间:2015-12-05 15:46:58      阅读:134      评论:0      收藏:0      [点我收藏+]

标签:

以下摘抄于 ( 高质量C++/C 编程指南,v 1.0   林锐),仅以记录回顾

 

1、标识符应当直观且可以拼读,可望文知意,不必进行“解码”。

标识符最好采用英文单词或其组合,便于记忆和阅读。切忌使用汉语拼音来命名。
程序中的英文单词一般不会太复杂,用词应当准确。

例如不要把CurrentValue写成NowValue。

 

2、标识符的长度应当符合“min-length && max-information”原则。 

几十年前老ANSI C规定名字不准超过6个字符,现今的 C++/C 不再有此限制。一
般来说,长名字能更好地表达含义,所以函数名、变量名、类名长达十几个字符不足为
怪。那么名字是否越长约好?不见得! 例如变量名 maxval 就比 maxValueUntilOverflow
好用。单字符的名字也是有用的,常见的如 i,j,k,m,n,x,y,z 等,它们通常可用作函数
内的局部变量。

 

3、命名规则尽量与所采用的操作系统或开发工具的风格保持一致。

例如Windows应用程序的标识符通常采用“大小写”混排的方式,如AddChild。

而Unix应用程序的标识符通常采用“小写加下划线”的方式,如add_child。

别把这两类风格混在一起用。

 

4、程序中不要出现仅靠大小写区分的相似的标识符。

例如:
int x, X; // 变量 x 与 X 容易混淆
void foo(int x); // 函数 foo 与 FOO容易混淆
void FOO(float x);

 

5、程序中不要出现标识符完全相同的局部变量和全局变量,尽管两者的作用域不同而不会发生语法错误,但会使人误解。

 

6、变量的名字应当使用“名词”或者“形容词+名词”。例如:

float value;
float oldValue;
float newValue; 

 

7、全局函数的名字应当使用“动词”或者“动词+名词”(动宾词组)。

类的成员函数应当只使用“动词”,被省略掉的名词就是对象本身。
例如:
DrawBox(); // 全局函数
box->Draw(); // 类的成员函数

 

8、用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。

例如:
int minValue;
int maxValue;
int SetValue(…);
int GetValue(…);

 

9、尽量避免名字中出现数字编号,如 Value1,Value2 等,除非逻辑上的确需要编号。

这是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名字(因为用数字编号最省事)。

 

命名规则

标签:

原文地址:http://www.cnblogs.com/kylinjade/p/5021536.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!