| 首页 | 技术文章 | 软件下载 | 博客 | 论坛 | 精品教程 | 黑客动画 | 视频资源 | 在线服务 | 黑客游戏 | 

您现在的位置: 中国X黑客小组 >> 技术文章 >> 编程技术 >> 综合其它 >> 文章正文 用户登录 新用户注册
  [推荐]编程修养         ★★★ 【字体:
编程修养
作者:未知    文章来源:网络    点击数:    更新时间:2008-6-21    


  1) 对malloc分配的内存进行memset清零操作。(可以使用calloc分配一块全零的内存)
  2) 对一些栈上分配的struct或数组进行初始化。(最好也是清零)
  
不过话又说回来了,初始化也会造成系统运行时间有一定的开销,所以,也不要对所有的变量做初始化,这个也没有意义。好的程序员知道哪些变量需要初始化,哪些则不需要。如:以下这种情况,则不需要。
    
    char *pstr; /* 一个字符串 */
    pstr = ( char* ) malloc( 50 );
    if ( pstr == NULL ) exit(0);
    strcpy( pstr, "Hello Wrold" );

但如果是下面一种情况,最好进行内存初始化。(指针是一个危险的东西,一定要初始化)

    char **pstr; /* 一个字符串数组 */
    pstr = ( char** ) malloc( 50 );
    if ( pstr == NULL ) exit(0);
    
    /* 让数组中的指针都指向NULL */
    memset( pstr, 0, 50*sizeof(char*) );
    
而对于全局变量,和静态变量,一定要声明时就初始化。因为你不知道它第一次会在哪里被使用。所以使用前初始这些变量是比较不现实的,一定要在声明时就初始化它们。如:

  Links *plnk = NULL; /* 对于全局变量plnk初始化为NULL */

10、h和c文件的使用

H文件和C文件怎么用呢?一般来说,H文件中是declare(声明),C文件中是define(定义)。因为C文件要编译成库文件(Windows下是.obj/.lib,UNIX下是.o/.a),如果别人要使用你的函数,那么就要引用你的H文件,所以,H文件中一般是变量、宏定义、枚举、结构和函数接口的声明,就像一个接口说明文件一样。而C文件则是实现细节。

H文件和C文件最大的用处就是声明和实现分开。这个特性应该是公认的了,但我仍然看到有些人喜欢把函数写在H文件中,这种习惯很不好。(如果是C++话,对于其模板函数,在VC中只有把实现和声明都写在一个文件中,因为VC不支持export关键字)。而且,如果在H文件中写上函数的实现,你还得在makefile中把头文件的依赖关系也加上去,这个就会让你的makefile很不规范。

最后,有一个最需要注意的地方就是:带初始化的全局变量不要放在H文件中!

例如有一个处理错误信息的结构:

  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",
    ......
    ......
  };
  
请不要把这个东西放在头文件中,因为如果你的这个头文件被5个函数库(.lib或是.a)所用到,于是他就被链接在这5个.lib或.a中,而如果你的一个程序用到了这5个函数库中的函数,并且这些函数都用到了这个出错信息数组。那么这份信息将有5个副本存在于你的执行文件中。如果你的这个errmsg很大的话,而且你用到的函数库更多的话,你的执行文件也会变得很大。

正确的写法应该把它写到C文件中,然后在各个需要用到errmsg的C文件头上加上 extern char* errmsg[]; 的外部声明,让编译器在链接时才去管他,这样一来,就只会有一个errmsg存在于执行文件中,而且,这样做很利于封装。

我曾遇到过的最疯狂的事,就是在我的目标文件中,这个errmsg一共有112个副本,执行文件有8M左右。当我把errmsg放到C文件中,并为一千多个C文件加上了extern的声明后,所有的函数库文件尺寸都下降了20%左右,而我的执行文件只有5M了。一下子少了3M啊。
〔 备注 〕

有朋友对我说,这个只是一个特例,因为,如果errmsg在执行文件中存在多个副本时,可以加快程序运行速度,理由是errmsg的多个复本会让系统的内存换页降低,达到效率提升。像我们这里所说的errmsg只有一份,当某函数要用errmsg时,如果内存隔得比较远,会产生换页,反而效率不高。

这个说法不无道理,但是一般而言,对于一个比较大的系统,errmsg是比较大的,所以产生副本导致执行文件尺寸变大,不仅增加了系统装载时间,也会让一个程序在内存中占更多的页面。而对于errmsg这样数据,一般来说,在系统运行时不会经常用到,所以还是产生的内存换页也就不算频繁。权衡之下,还是只有一份errmsg的效率高。即便是像logmsg这样频繁使用的的数据,操作系统的内存调度算法会让这样的频繁使用的页面常驻于内存,所以也就不会出现内存换页问题了

11、出错信息的处理

你会处理出错信息吗?哦,它并不是简单的输出。看下面的示例:

  if ( p == NULL ){
    printf ( "ERR: The pointer is NULLn" );
  }
  
告别学生时代的编程吧。这种编程很不利于维护和管理,出错信息或是提示信息,应该统一处理,而不是像上面这样,写成一个“硬编码”。第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: %sn", info, errmsg[errno] );
      return;
    }
    
    printf("Error: %sn", 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, ServerListener -> ServLisner,UserAccount -> UsrAcct 等。
5) 为了避免全局函数和变量名字冲突,可以加上一些前缀,一般以模块简称做为前缀。
6) 全局变量统一加一个前缀或是后缀,让人一看到这个变量就知道是全局的。
7) 用匈牙利命名法命名函数参数,局部变量。但还是要坚持“望文生意”的原则。
8) 与标准库(如: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或是SourceSafe这种版本控制软件,还是要在源码上给别人看到你修改程序的意图和步骤。这是程序维护时,一个有修养的程序员所应该做的。

如下所示,这就是一种比较好的修改方法:

  /*
   * ----- 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 );
  /* ---------------------------------------- */
  ...

当然,这种方法是在软件维护时使用的,这样的方法,可以让再维护的人很容易知道以前的代码更改的动作和意图,而且这也是对原作者的一种尊敬。

以“注释 - 添加”方式修改别人的程序,要好于直接删除别人的程序。

16、把相同或近乎相同的代码形成函数和宏

有人说,最好的程序员,就是最喜欢“偷懒”的程序,其中不无道理。

如果你有一些程序的代码片段很相似,或直接就是一样的,请把他们放在一个函数中。而如果这段代码不多,而且会被经常使用,你还想避免函数调用的开销,那么就把他写成宏吧。

千万不要让同一份代码或是功能相似的代码在多个地方存在,不然如果功能一变,你就要修改好几处地方,这种会给维护带来巨大的麻烦,所以,做到“一改百改”,还是要形成函数或是宏。

17、表达式中的括号

如果一个比较复杂的表达式中,你并不是很清楚各个操作符的忧先级,即使是你很清楚优先级,也请加上括号,不然,别人或是自己下一次读程序时,一不小心就看走眼理解错了,为了避免这种“误解”,还有让自己的程序更为清淅,还是加上括号吧。

比如,对一个结构的成员取地址:

  GetUserAge( &( UserInfo->age ) );
虽然,&UserInfo->age中,->操作符的优先级最高,但加上一个括号,会让人一眼就看明白你的代码是什么意思。
再比如,一个很长的条件判断:
if ( ( ch[0] >= ′0′ || ch[0] <= ′9′ ) &&
   ( ch[1] >= ′a′ || ch[1] <= ′z′ ) &&
   ( ch[2] >= ′A′ || ch[2] <= ′Z′ )  )
  
括号,再加上空格和换行,你的代码是不是很容易读懂了?  

18、函数参数中的const

对于一些函数中的指针参数,如果在函数中只读,请将其用const修饰,这样,别人一读到你的函数接口时,就会知道你的意图是这个参数是[in],如果没有const时,参数表示[in/out],注意函数接口中的const使用,利于程序的维护和避免犯一些错误。

虽然,const修饰的指针,如:const char* p,在C中一点用也没有,因为不管你的声明是不是const,指针的内容照样能改,因为编译器会强制转换,但是加上这样一个说明,有利于程序的阅读和编译。因为在C中,修改一个const指针所指向的内存时,会报一个Warning。这会引起程序员的注意。

C++中对const定义的就很严格了,所以C++中要多多的使用const,const的成员函数,const的变量,这样会对让你的代码和你的程序更加完整和易读。(关于C++的const我就不多说了)

19、函数的参数个数(多了请用结构)

函数的参数个数最好不要太多,一般来说6个左右就可以了,众多的函数参数会让读代码的人一眼看上去就很头昏,而且也不利于维护。如果参数众多,还请使用结构来传递参数。这样做有利于数据的封装和程序的简洁性。

也利于使用函数的人,因为如果你的函数个数很多,比如12个,调用者很容易搞错参数的顺序和个数,而使用结构struct来传递参数,就可以不管参数的顺序。

而且,函数很容易被修改,如果需要给函数增加参数,不需要更改函数接口,只需更改结构体和函数内部处理,而对于调用函数的程序来说,这个动作是透明的。

20、函数的返回类型,不要省略

我看到很多程序写函数时,在函数的返回类型方面不太注意。如果一个函数没有返回值,也请在函数前面加上void的修饰。而有的程序员偷懒,在返回int的函数则什么不修饰(因为如果不修饰,则默认返回int),这种习惯很不好,还是为了原代码的易读性,加上int吧。
所以函数的返回值类型,请不要省略。

另外,对于void的函数,我们往往会忘了return,由于某些C/C++的编译器比较敏感,会报一些警告,所以即使是void的函数,我们在内部最好也要加上return的语句,这有助于代码的编译。

21、goto语句的使用

N年前,软件开发的一代宗师--迪杰斯特拉(Dijkstra)说过:“goto statment is harmful !!”,并建议取消goto语句。因为goto语句不利于程序代码的维护性。

这里我也强烈建议不要使用goto语句,除非下面的这种情况:
  #define FREE(p) if(p) {
            free(p);
            p = NULL;
          }
  main()
  {
    char *fname=NULL, *lname=NULL, *mname=NULL;
    fname = ( char* ) calloc ( 20, sizeof(char) );
    if ( fname == NULL ){
      goto ErrHandle;
    }
    lname = ( char* ) calloc ( 20, sizeof(char) );
    if ( lname == NULL ){
      goto ErrHandle;
    }
    mname = ( char* ) calloc ( 20, sizeof(char) );
    if ( mname == NULL ){
      got

上一页  [1] [2] [3] 下一页

文章录入:血腥魔术师    责任编辑:血腥魔术师 
  • 上一篇文章:

  • 下一篇文章: 没有了
  • 发表评论】【加入收藏】【告诉好友】【打印此文】【关闭窗口
    最新热点 最新推荐 相关文章
    鲍尔默:微软每年至少投资25
    瑞星07月25日发布 每日病毒及
    已有黑客在研制利用DNS漏洞程
    腾讯官方版Linux QQ将于本月
    无法进入安全模式 可能中招“
    瑞星公司07月15日发布 每日计
    微软七月安全公告预告:四个重
    PlayStation官方网站被注入恶
    百度暴xssworm   跨站 漏洞
    Flash漏洞最新疫情:一周感染
      网友评论:(只显示最新5条。评论内容只代表网友观点,与本站立场无关!)
    Powered by ICE RIVER - STUDIO
    » CnXHacker.CoM   © CopyRight 2002-2006, CnXHacker.CoM™, Inc. All Rights Reserved.