码迷,mamicode.com
首页 > 编程语言 > 详细

C++新手之培养良好的编程风格

时间:2015-08-17 08:40:07      阅读:119      评论:0      收藏:0      [点我收藏+]

标签:

内功深厚的武林高手出招往往平淡无奇。同理,编程高手也不会用奇门怪招写程序。良好的编程风格是产生高质量程序的前提。 下面以C++为例,来给大家介绍。

一、 命名约定

有不少人编程时用拼音给函数或变量命名,这样做并不能说明你很爱国,却会让用此程序的人迷糊(很多南方人不懂拼音,我就不懂)。程序中的英文一般不会太复杂,用词要力求准确。匈牙利命名法是Microsoft 公司倡导的[Maguire 1993],虽然很烦琐,但用习惯了也就成了自然。没有人强迫你采用何种命名法,但有一点应该做到:自己的程序命名必须一致。

以下是我编程时采用的命名约定:

(1)宏定义用大写字母加下划线表示,如MAX_LENGTH;

(2)函数用大写字母开头的单词组合而成,如SetName, GetName ;

(3)指针变量加前缀p,如*pNode ;

(4)BOOL 变量加前缀b,如bFlag ;

(5)int 变量加前缀i,如iWidth ; 

(6)float 变量加前缀f,如fWidth ;

(7)double 变量加前缀d,如dWidth ;

(8)字符串变量加前缀str,如strName ;

(9)枚举变量加前缀e,如eDrawMode ;

(10)类的成员变量加前缀m_,如m_strName, m_iWidth ;

对于int, float, double 型的变量,如果变量名的含义十分明显,则不加前缀,避免烦琐。如用于循环的int 型变量i,j,k ;float 型的三维坐标(x,y,z)等。

二、 使用断言

程序一般分为Debug 版本和Release 版本,Debug 版本用于内部调试,Release 版本发行给用户使用。断言assert 是仅在Debug 版本起作用的宏,它用于检查“不应该”发生的情况。以下是一个内存复制程序,在运行过程中,如果assert 的参数为假,那么程序就会中止(一般地还会出现提示对话,说明在什么地方引发了assert)。

  1. //复制不重叠的内存块  
  2. void memcpy(void *pvTo, void *pvFrom, size_t size)  
  3. {  
  4. void *pbTo = (byte *) pvTo;  
  5. void *pbFrom = (byte *) pvFrom;  
  6. assert( pvTo != NULL && pvFrom != NULL );  
  7. while(size - - > 0 )  
  8. *pbTo + + = *pbFrom + + ;  
  9. return (pvTo);  

assert 不是一个仓促拼凑起来的宏,为了不在程序的Debug 版本和Release 版本引起差别,assert 不应该产生任何副作用。所以assert 不是函数,而是宏。程序员可以把assert 看成一个在任何系统状态下都可以安全使用的无害测试手段。

很少有比跟踪到程序的断言,却不知道该断言的作用更让人沮丧的事了。你化了很多时间,不是为了排除错误,而只是为了弄清楚这个错误到底是什么。有的时候,程序员偶尔还会设计出有错误的断言。所以如果搞不清楚断言检查的是什么,就很难判断错误是出现在程序中,还是出现在断言中。幸运的是这个问题很好解决,只要加上清晰的注释即可。这本是显而易见的事情,可是很少有程序员这样做。这好比一个人在森林里,看到树上钉着一块“危险”的大牌子。但危险到底是什么?树要倒?有废井?有野兽?除非告诉人们“危险”是什么,否则这个警告牌难以起到积极有效的作用。难以理解的断言常常被程序员忽略,甚至被删除。[Maguire 1993]

以下是使用断言的几个原则:

(1)使用断言捕捉不应该发生的非法情况。不要混淆非法情况与错误情况之间的区别,后者是必然存在的并且是一定要作出处理的。

(2)使用断言对函数的参数进行确认。

(3)在编写函数时,要进行反复的考查,并且自问:“我打算做哪些假定?”一旦确定了的假定,就要使用断言对假定进行检查。

(4)一般教科书都鼓励程序员们进行防错性的程序设计,但要记住这种编程风格会隐瞒错误。当进行防错性编程时,如果“不可能发生”的事情的确发生了,则要使用断言进行报警。

三、 new、delete 与指针

在C++中,操作符new 用于申请内存,操作符delete 用于释放内存。在C 语言中,函数malloc 用于申请内存,函数free 用于释放内 存。由于C++兼容C 语言,所以new、delete、malloc、free 都有可能一起使用。new 能比malloc 干更多的事,它可以申请对象的内存,而malloc 不能。C++和C 语言中的指针威猛无比,用错了会带来灾难。对于一个指针p,如果是用new申请的内存,则必须用delete 而不能用free 来释放。如果是用malloc 申请的内存,则必须用free 而不能用delete 来释放。在用delete 或用free 释放p 所指的内存后,应该马上显式地将p 置为NULL,以防下次使用p 时发生错误。示例程序如下:

  1. void Test(void)  
  2. {  
  3. float *p;  
  4. p = new float[100];  
  5. if(p==NULL) return;  
  6. …// do something  
  7. delete p;  
  8. p=NULL; // 良好的编程风格  
  9. // 可以继续使用p  
  10. p = new float[500];  
  11. if(p==NULL) return;  
  12. …// do something else  
  13. delete p;  
  14. p=NULL;  

我们还要预防“野指针”,“野指针”是指向“垃圾”内存的指针,主要成因有两种:

(1)指针没有初始化。

(2)指针指向已经释放的内存,这种情况最让人防不胜防,示例程序如下:

  1. class A  
  2. {  
  3. public:  
  4. void Func(void){…}  
  5. };  
  6. void Test(void)  
  7. {  
  8. A *p;  
  9. {  
  10. A a;  
  11. p = &a; // 注意a 的生命期  
  12. }  
  13. p->Func(); // p 是“野指针”,程序出错  

四、使用const

在定义一个常量时,const 比#define 更加灵活。用const 定义的常量含有数据类型,该常量可以参与逻辑运算。例如:

  1. const int LENGTH = 100; // LENGTH 是int 类型  
  2. const float MAX=100; // MAX 是float 类型  
  3. #define LENGTH 100 // LENGTH 无类型  
  4. #define MAX 100 // MAX 无类型 

除了能定义常量外,const 还有两个“保护”功能:

一、强制保护函数的参数值不发生变化

以下程序中,函数f 不会改变输入参数name 的值,但是函数g 和h 都有可能改变name的值。

  1. void f(String s); // pass by value  
  2. void g(String &s); // pass by referance  
  3. void h(String *s); // pass by pointer  
  4. main()  
  5. {  
  6. String name=“Dog”;  
  7. f(name); // name 的值不会改变  
  8. g(name); // name 的值可能改变  
  9. h(name); // name 的值可能改变  

对于一个函数而言,如果其‘&’或‘*’类型的参数只作输入用,不作输出用,那么应当在该参数前加上const,以确保函数的代码不会改变该参数的值(如果改变了该参数的值,编译器会出现错误警告)。因此上述程序中的函数g 和h 应该定义成:

  1. void g(const String &s);  
  2. void h(const String *s); 

二、强制保护类的成员函数不改变任何数据成员的值

以下程序中,类stack 的成员函数Count 仅用于计数,为了确保Count 不改变类中的任何数据成员的值,应将函数Count 定义成const 类型。

  1. class Stack  
  2. {  
  3. public:  
  4. void push(int elem);  
  5. void pop(void);  
  6. int Count(void) const; // const 类型的函数  
  7. private:  
  8. int num;  
  9. int data[100];  
  10. };  
  11. int Stack::Count(void) const 
  12. {  
  13. ++ num; // 编译错误,num 值发生变化  
  14. pop(); // 编译错误,pop 将改变成员变量的值  
  15. return num;  

五、 其它建议

(1)不要编写一条过分复杂的语句,紧凑的C++/C 代码并不见到能得到高效率的机器代码,却会降低程序的可理解性,程序出错误的几率也会提高。

(2)不要编写集多种功能于一身的函数,在函数的返回值中,不要将正常值和错误标志混在一起。

(3)不要将BOOL 值TRUE 和FALSE 对应于1 和0 进行编程。大多数编程语言将FALSE定义为0,任何非0 值都是TRUE。Visual C++将TRUE 定义为1,而Visual Basic 则将TRUE定义为-1。示例程序如下:

  1. BOOL flag;  
  2. …  
  3. if(flag) { // do something } // 正确的用法  
  4. if(flag==TRUE) { // do something } // 危险的用法  
  5. if(flag==1) { // do something } // 危险的用法  
  6. if(!flag) { // do something } // 正确的用法  
  7. if(flag==FALSE) { // do something } // 不合理的用法  
  8. if(flag==0) { // do something } // 不合理的用法 

(4)小心不要将“= =”写成“=”,编译器不会自动发现这种错误。

(5)不要将123 写成0123,后者是八进制的数值。

(6)将自己经常犯的编程错误记录下来,制成表格贴在计算机旁边。

 小结

C++/C 程序设计如同少林寺的武功一样博大精深,我练了8 年,大概只学到二三成。所以无论什么时候,都不要觉得自己的编程水平天下第一,看到别人好的技术和风格,要虚心学习。本章的内容少得可怜,就象口渴时只给你一颗杨梅吃,你一定不过瘾。我借花献佛,推荐一本好书:Marshall P. Cline 著的《C++ FAQs》[Cline 1995]。你看了后一定会赞不绝口。会编写C++/C 程序,不要因此得意洋洋,这只是程序员基本的技能要求而已。如果把系统分析和系统设计比作“战略决策”,那么编程充其量只是“战术”。

如果指挥官是个大笨蛋,士兵再勇敢也会吃败仗。所以我们程序员不要只把眼光盯在程序上,要让自己博学多才。我们应该向北京胡同里的小孩们学习,他们小小年纪就能指点江山,评论世界大事。

C++新手之培养良好的编程风格

标签:

原文地址:http://www.cnblogs.com/hujingwei/p/4735572.html

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