编程修养(4)(转载)

dragon_kai

11、出错信息的处理
—————————
你会处理出错信息吗？哦，它并不是简单的输出。看下面的示例：
if ( p == NULL ){
printf ( \"ERR: The pointer is NULL\\n\" );
}
告别学生时代的编程吧。这种编程很不利于维护和管理，出错信息或是提示信息，应该
统一处理，而不是像上面这样，写成一个“硬编码”。第10条对这方面的处理做了一部
分说明。如果要管理错误信息，那就要有以下的处理：
/* 声明出错代码 */
#define ERR_NO_ERROR 0 /* No error */
#define ERR_OPEN_FILE 1 /* Open file error */
#define ERR_SEND_MESG 2 /* sending a message error */
#define ERR_BAD_ARGS 3 /* Bad arguments */
#define ERR_MEM_NONE 4 /* Memeroy is not enough */
#define ERR_SERV_DOWN 5 /* Service down try later */
#define ERR_UNKNOW_INFO 6 /* Unknow information */
#define ERR_SOCKET_ERR 7 /* Socket operation failed */
#define ERR_PERMISSION 8 /* Permission denied */
#define ERR_BAD_FORMAT 9 /* Bad configuration file */
#define ERR_TIME_OUT 10 /* Communication time out */
/* 声明出错信息 */
char* errmsg[] = {
/* 0 */ \"No error\",
/* 1 */ \"Open file error\",
/* 2 */ \"Failed in sending/receiving a message\",
/* 3 */ \"Bad arguments\",
/* 4 */ \"Memeroy is not enough\",
/* 5 */ \"Service is down; try later\",
/* 6 */ \"Unknow information\",
/* 7 */ \"A socket operation has failed\",
/* 8 */ \"ermission denied\",
/* 9 */ \"Bad configuration file format\",
/* 10 */ \"Communication time out\",
};
/* 声明错误代码全局变量 */
long errno = 0;
/* 打印出错信息函数 */
void perror( char* info)
{
if ( info ){
printf(\"%s: %s\\n\", info, errmsg[errno] );
return;
}
printf(\"Error: %s\\n\", errmsg[errno] );
}
这个基本上是ANSI的错误处理实现细节了，于是当你程序中有错误时你就可以这样处理
：
bool CheckPermission( char* userName )
{
if ( strcpy(userName, \"root\") != 0 ){
errno = ERR_PERMISSION_DENIED;
return (FALSE);
}
...
}
main()
{
...
if (! CheckPermission( username ) ){
perror(\"main()\");
}
...
}
一个即有共性，也有个性的错误信息处理，这样做有利同种错误出一样的信息，统一用
户界面，而不会因为文件打开失败，A程序员出一个信息，B程序员又出一个信息。而且
这样做，非常容易维护。代码也易读。
当然，物极必反，也没有必要把所有的输出都放到errmsg中，抽取比较重要的出错信息
或是提示信息是其关键，但即使这样，这也包括了大多数的信息。
12、常用函数和循环语句中的被计算量
—————————————————
看一下下面这个例子：
for( i=0; i<1000; i++ ){
GetLocalHostName( hostname );
...
}
GetLocalHostName的意思是取得当前计算机名，在循环体中，它会被调用1000次啊。这
是多么的没有效率的事啊。应该把这个函数拿到循环体外，这样只调用一次，效率得到
了很大的提高。虽然，我们的编译器会进行优化，会把循环体内的不变的东西拿到循环
外面，但是，你相信所有编译器会知道哪些是不变的吗？我觉得编译器不可靠。最好还
是自己动手吧。
同样，对于常用函数中的不变量，如：
GetLocalHostName(char* name)
{
char funcName[] = \"GetLocalHostName\";
sys_log( \"%s begin......\", funcName );
...
sys_log( \"%s end......\", funcName );
}
如果这是一个经常调用的函数，每次调用时都要对funcName进行分配内存，这个开销很
大啊。把这个变量声明成static吧，当函数再次被调用时，就会省去了分配内存的开销
，执行效率也很好。
13、函数名和变量名的命名
————————————
我看到许多程序对变量名和函数名的取名很草率，特别是变量名，什么a,b,c,aa,bb,cc
，还有什么flag1,flag2, cnt1, cnt2，这同样是一种没有“修养”的行为。即便加上好
的注释。好的变量名或是函数名，我认为应该有以下的规则：
1) 直观并且可以拼读，可望文知意，不必“解码”。
2) 名字的长度应该即要最短的长度，也要能最大限度的表达其含义。
3) 不要全部大写，也不要全部小写，应该大小写都有，如：GetLocalHostName 或
是 UserAccount。
4) 可以简写，但简写得要让人明白，如：ErrorCode -> ErrCode, ServerListen
er -> ServLisner，UserAccount -> UsrAcct 等。
5) 为了避免全局函数和变量名字冲突，可以加上一些前缀，一般以模块简称做为前
缀。
6) 全局变量统一加一个前缀或是后缀，让人一看到这个变量就知道是全局的。
7) 用匈牙利命名法命名函数参数，局部变量。但还是要坚持“望文生意”的原则。

Cool 与标准库（如：STL）或开发库（如：MFC）的命名风格保持一致。
14、函数的传值和传指针
————————————
向函数传参数时，一般而言，传入非const的指针时，就表示，在函数中要修改这个指针
把指内存中的数据。如果是传值，那么无论在函数内部怎么修改这个值，也影响不到传
过来的值，因为传值是只内存拷贝。
什么？你说这个特性你明白了，好吧，让我们看看下面的这个例程：
void
GetVersion(char* pStr)
{
pStr = malloc(10);
strcpy ( pStr, \"2.0\" );
}
main()
{
char* ver = NULL;
GetVersion ( ver );
...
...
free ( ver );
}
我保证，类似这样的问题是一个新手最容易犯的错误。程序中妄图通过函数GetVersion
给指针ver分配空间，但这种方法根本没有什么作用，原因就是——这是传值，不是传指
针。你或许会和我争论，我分明传的时指针啊？再仔细看看，其实，你传的是指针其实
是在传值。
15、修改别人程序的修养
———————————
当你维护别人的程序时，请不要非常主观臆断的把已有的程序删除或是修改。我经常看
到有的程序员直接在别人的程序上修改表达式或是语句。修改别人的程序时，请不要删
除别人的程序，如果你觉得别人的程序有所不妥，请注释掉，然后添加自己的处理程序
，必竟，你不可能100%的知道别人的意图，所以为了可以恢复，请不依赖于CVS或是Sou
rceSafe这种版本控制软件，还是要在源码上给别人看到你修改程序的意图和步骤。这是
程序维护时，一个有修养的程序员所应该做的。
如下所示，这就是一种比较好的修改方法：
/*
* ----- commented by haoel 2003/04/12 ------
*
* char* p = ( char* ) malloc( 10 );
* memset( p, 0, 10 );
*/
/* ------ Added by haoel 2003/04/12 ----- */
char* p = ( char* )calloc( 10, sizeof char );
/* ---------------------------------------- */
...
当然，这种方法是在软件维护时使用的，这样的方法，可以让再维护的人很容易知道以
前的代码更改的动作和意图，而且这也是对原作者的一种尊敬。
以“注释 — 添加”方式修改别人的程序，要好于直接删除别人的程序。

dragon_kai

11、出错信息的处理
—————————
你会处理出错信息吗？哦，它并不是简单的输出。看下面的示例：
if ( p == NULL ){
printf ( \"ERR: The pointer is NULL\\n\" );
}
告别学生时代的编程吧。这种编程很不利于维护和管理，出错信息或是提示信息，应该
统一处理，而不是像上面这样，写成一个“硬编码”。第10条对这方面的处理做了一部
分说明。如果要管理错误信息，那就要有以下的处理：
/* 声明出错代码 */
#define ERR_NO_ERROR 0 /* No error */
#define ERR_OPEN_FILE 1 /* Open file error */
#define ERR_SEND_MESG 2 /* sending a message error */
#define ERR_BAD_ARGS 3 /* Bad arguments */
#define ERR_MEM_NONE 4 /* Memeroy is not enough */
#define ERR_SERV_DOWN 5 /* Service down try later */
#define ERR_UNKNOW_INFO 6 /* Unknow information */
#define ERR_SOCKET_ERR 7 /* Socket operation failed */
#define ERR_PERMISSION 8 /* Permission denied */
#define ERR_BAD_FORMAT 9 /* Bad configuration file */
#define ERR_TIME_OUT 10 /* Communication time out */
/* 声明出错信息 */
char* errmsg[] = {
/* 0 */ \"No error\",
/* 1 */ \"Open file error\",
/* 2 */ \"Failed in sending/receiving a message\",
/* 3 */ \"Bad arguments\",
/* 4 */ \"Memeroy is not enough\",
/* 5 */ \"Service is down; try later\",
/* 6 */ \"Unknow information\",
/* 7 */ \"A socket operation has failed\",
/* 8 */ \"ermission denied\",
/* 9 */ \"Bad configuration file format\",
/* 10 */ \"Communication time out\",
};
/* 声明错误代码全局变量 */
long errno = 0;
/* 打印出错信息函数 */
void perror( char* info)
{
if ( info ){
printf(\"%s: %s\\n\", info, errmsg[errno] );
return;
}
printf(\"Error: %s\\n\", errmsg[errno] );
}
这个基本上是ANSI的错误处理实现细节了，于是当你程序中有错误时你就可以这样处理
：
bool CheckPermission( char* userName )
{
if ( strcpy(userName, \"root\") != 0 ){
errno = ERR_PERMISSION_DENIED;
return (FALSE);
}
...
}
main()
{
...
if (! CheckPermission( username ) ){
perror(\"main()\");
}
...
}
一个即有共性，也有个性的错误信息处理，这样做有利同种错误出一样的信息，统一用
户界面，而不会因为文件打开失败，A程序员出一个信息，B程序员又出一个信息。而且
这样做，非常容易维护。代码也易读。
当然，物极必反，也没有必要把所有的输出都放到errmsg中，抽取比较重要的出错信息
或是提示信息是其关键，但即使这样，这也包括了大多数的信息。
12、常用函数和循环语句中的被计算量
—————————————————
看一下下面这个例子：
for( i=0; i<1000; i++ ){
GetLocalHostName( hostname );
...
}
GetLocalHostName的意思是取得当前计算机名，在循环体中，它会被调用1000次啊。这
是多么的没有效率的事啊。应该把这个函数拿到循环体外，这样只调用一次，效率得到
了很大的提高。虽然，我们的编译器会进行优化，会把循环体内的不变的东西拿到循环
外面，但是，你相信所有编译器会知道哪些是不变的吗？我觉得编译器不可靠。最好还
是自己动手吧。
同样，对于常用函数中的不变量，如：
GetLocalHostName(char* name)
{
char funcName[] = \"GetLocalHostName\";
sys_log( \"%s begin......\", funcName );
...
sys_log( \"%s end......\", funcName );
}
如果这是一个经常调用的函数，每次调用时都要对funcName进行分配内存，这个开销很
大啊。把这个变量声明成static吧，当函数再次被调用时，就会省去了分配内存的开销
，执行效率也很好。
13、函数名和变量名的命名
————————————
我看到许多程序对变量名和函数名的取名很草率，特别是变量名，什么a,b,c,aa,bb,cc
，还有什么flag1,flag2, cnt1, cnt2，这同样是一种没有“修养”的行为。即便加上好
的注释。好的变量名或是函数名，我认为应该有以下的规则：
1) 直观并且可以拼读，可望文知意，不必“解码”。
2) 名字的长度应该即要最短的长度，也要能最大限度的表达其含义。
3) 不要全部大写，也不要全部小写，应该大小写都有，如：GetLocalHostName 或
是 UserAccount。
4) 可以简写，但简写得要让人明白，如：ErrorCode -> ErrCode, ServerListen
er -> ServLisner，UserAccount -> UsrAcct 等。
5) 为了避免全局函数和变量名字冲突，可以加上一些前缀，一般以模块简称做为前
缀。
6) 全局变量统一加一个前缀或是后缀，让人一看到这个变量就知道是全局的。
7) 用匈牙利命名法命名函数参数，局部变量。但还是要坚持“望文生意”的原则。

Cool 与标准库（如：STL）或开发库（如：MFC）的命名风格保持一致。
14、函数的传值和传指针
————————————
向函数传参数时，一般而言，传入非const的指针时，就表示，在函数中要修改这个指针
把指内存中的数据。如果是传值，那么无论在函数内部怎么修改这个值，也影响不到传
过来的值，因为传值是只内存拷贝。
什么？你说这个特性你明白了，好吧，让我们看看下面的这个例程：
void
GetVersion(char* pStr)
{
pStr = malloc(10);
strcpy ( pStr, \"2.0\" );
}
main()
{
char* ver = NULL;
GetVersion ( ver );
...
...
free ( ver );
}
我保证，类似这样的问题是一个新手最容易犯的错误。程序中妄图通过函数GetVersion
给指针ver分配空间，但这种方法根本没有什么作用，原因就是——这是传值，不是传指
针。你或许会和我争论，我分明传的时指针啊？再仔细看看，其实，你传的是指针其实
是在传值。
15、修改别人程序的修养
———————————
当你维护别人的程序时，请不要非常主观臆断的把已有的程序删除或是修改。我经常看
到有的程序员直接在别人的程序上修改表达式或是语句。修改别人的程序时，请不要删
除别人的程序，如果你觉得别人的程序有所不妥，请注释掉，然后添加自己的处理程序
，必竟，你不可能100%的知道别人的意图，所以为了可以恢复，请不依赖于CVS或是Sou
rceSafe这种版本控制软件，还是要在源码上给别人看到你修改程序的意图和步骤。这是
程序维护时，一个有修养的程序员所应该做的。
如下所示，这就是一种比较好的修改方法：
/*
* ----- commented by haoel 2003/04/12 ------
*
* char* p = ( char* ) malloc( 10 );
* memset( p, 0, 10 );
*/
/* ------ Added by haoel 2003/04/12 ----- */
char* p = ( char* )calloc( 10, sizeof char );
/* ---------------------------------------- */
...
当然，这种方法是在软件维护时使用的，这样的方法，可以让再维护的人很容易知道以
前的代码更改的动作和意图，而且这也是对原作者的一种尊敬。
以“注释 — 添加”方式修改别人的程序，要好于直接删除别人的程序。