培养良好编程习惯(一)

一 26th, 2010 | Filed under Thinking

转载请注明出处:http://www.figoyao.com/blog/2010/01/26/787

编程习惯的好坏影响的是代码的可阅读和可维护性,尤其是在代码规模扩大时,就不能随意去编写代码。前面教程对于这些细节没有提及,所以在这里专门讲一下。下面主要涉及这么几个方面:
1、缩进格式
2、命名习惯
3、注释习惯

缩进格式的话没有统一的好坏标准,但是有个一致性原则,就是说如果你使用了一种形式,那么就要保持使用这种形式。如:

	//第一种形式
	for (int i = 0;i < 10;i++)
	{
		test();
	}

	//第二种形式
	for (int i = 0;i < 10;i++)
		{
		test();
		}

	//第三种形式
	for (int i = 0;i < 10;i++)
		{
			test();
		}

	//第四种形式
	for (int i = 0;i < 10;i++)
	{
	test();
	}

	//第五种形式
	for (int i = 0;i < 10;i++){
		test();
	}

上面给出的是比较有代表性的五种缩进形式,没有哪种比其它阅读起来更容易,但是,如果你选定了一种形式,就应该保持这种形式成为自己的习惯。而且我提倡分块结构,就是说把功能一致的代码用大括号标识,哪怕只有一句话,这对于后期维护和扩充是很有好处的。最后需要注意的是二元操作符两边最好各加一个空格

命名习惯涉及到如何命名和如何定义变量2个方面。在定义变量时,我推荐的是匈牙利命名法,但是不要教条主义,有时候特殊情况特殊处理,对于全局(Global)变量最好加上g_前缀。对于宏的命名最好全部大写;对于函数命名最好使用有意义的单词组合标识;在定义变量时,最好一个变量占一行,这样便于在以后改变变量类型时候易于修改;对于引出的变量一定要在定义时(使用前)初始化,否则可能会产生不可预料的错误:

	//定义一个全局计数器
	int g_iCnt = 0;

	//不推荐这种方式
	int iTest = 0,iSec = 60;

	//将来想把iTest改为double型直接修改即可
	int iTest = 0;
	int iSec = 60;

注释习惯似乎没有前两者重要,但一个好的注释对于别人阅读你的代码是带有裨益的,尤其是在大项目中更为必要。有句话在程序员中一直流传:“有多少种程序员就有多少种注释风格。”这说明了注释的多样性和无标准性,还是那个观点,一致性的注释对于代码维护时很重要的,常见的集中注释方式如下:

/*******************
*                  *
*	figoyao.com    *
*                  *
*******************/

/*******************
*
*	figoyao.com
*
*******************/

/*
	figoyao.com
				 */

/*
	figoyao.com
*/

/*
*	figoyao.com
*/

//figoyao.com

对于大段注释可以采用前面几种,对于简单注释则推荐使用最好一种方式,还是强调注意一致性原则。一般来说,注释应该提供的信息是你这段代码的目的而不是实现机制,所谓目的就是你这段代码是干什么用的,实现机制就是你这段代码是使用for循环实现还是使用while循环实现这类信息不必特意说明,但对于特殊情况下实现机制还是需要说明的,比如你自创的算法:)

大致先谈这么多,以后再逐渐补充,希望对你有所帮助。

标签: , ,
目前还没有任何评论.