位置:51电子网 » 技术资料 » 其它综合

好的程序员必做之事

发布时间:2008/7/15 0:00:00 访问次数:349

1、版权和版本
-------
好的程序员会给自己的每个函数,每个文件,都注上版权和版本。
对于c/c++的文件,文件头应该有类似这样的注释:
/********************************************************************
*
*  文件名:network.c
*
*  文件描述:网络通讯函数集
*
*  创建人: hao chen, 2003年2月3日
*
*  版本号:1.0
*
*  修改记录:
*
********************************************************************/

而对于函数来说,应该也有类似于这样的注释:

/*============================================================
*
* 函 数 名:xxx
*
* 参  数:
*
*    type name [in] : descripts
*
* 功能描述:
*
*    ..............
*
* 返 回 值:成功true,失败false
*
* 抛出异常:
*
* 作  者:chenhao 2003/4/2
*
============================================================*/

这样的描述可以让人对一个函数,一个文件有一个总体的认识,对代码的易读性和易维护性有很大的好处。这是好的作品产生的开始。


2、缩进、空格、换行、空行、对齐
----------------
i) 缩进应该是每个程序都会做的,只要学程序过程序就应该知道这个,但是我仍然看过不缩进的程序,或是乱缩进的程序,如果你的公司还有写程序不缩进的程序员,请毫不犹豫的开除他吧,并以破坏源码罪起诉他,还要他赔偿读过他程序的人的精神损失费。缩进,这是不成文规矩,我再重提一下吧,一个缩进一般是一个tab键或是4个空格。(最好用tab键)
ii) 空格。空格能给程序代来什么损失吗?没有,有效的利用空格可以让你的程序读进来更加赏心悦目。而不一堆表达式挤在一起。看看下面的代码:
  ha=(ha*128+*key++)%tabptr->size;
  ha = ( ha * 128 + *key++ ) % tabptr->size;
  有空格和没有空格的感觉不一样吧。一般来说,语句中要在各个操作符间加空格,函数调用时,要以各个参数间加空格。如下面这种加空格的和不加的:
  
if ((hproc=openprocess(process_all_access,false,pid))==null){
}
if ( ( hproc = openprocess(process_all_access, false, pid) ) == null ){
}
iii) 换行。不要把语句都写在一行上,这样很不好。如:
  for(i=0;i'9')&&(a[i]<'a'||a[i]>'z')) break;
  
  这种即无空格,又无换行的程序在写什么啊?加上空格和换行吧。  
  
  for ( i=0; i     if ( ( a[i] < '0' || a[i] > '9' ) &&
       ( a[i] < 'a' || a[i] > 'z' ) ) {
      break;
    }
  }
  好多了吧?有时候,函数参数多的时候,最好也换行,如:
  createprocess(
         null,
         cmdbuf,
         null,
         null,
         binhh,
         dwcrtflags,
         envbuf,
         null,
         &sistartinfo,
         &prinfo
         );
  条件语句也应该在必要时换行:
  
  if ( ch >= '0' || ch <= '9' ||
     ch >= 'a' || ch <= 'z' ||
     ch >= 'a' || ch <= 'z' )
         
iv) 空行。不要不加空行,空行可以区分不同的程序块,程序块间,最好加上空行。如:
  handle hprocess;
  process_t procinfo;
  /* open the process handle */
  if((hprocess = openprocess(process_all_access, false, pid)) == null)
  {
    return lse_misc_sys;
  }
  memset(&procinfo, 0, sizeof(procinfo));
  procinfo.idproc = pid;
  procinfo.hdproc = hprocess;
  procinfo.misc |= mscava_proc;
  return(0);
         
v) 对齐。用tab键对齐你的一些变量的声明或注释,一样会让你的程序好看一些。如:
typedef struct _pt_man_t_ {
  int   numproc;  /* number of processes         */
  int   maxproc;  /* max number of processes       */
  int   numevnt;  /* number of events          */
  int   maxevnt;  /* max number of events        */
  handle* phndevnt;  /*

1、版权和版本
-------
好的程序员会给自己的每个函数,每个文件,都注上版权和版本。
对于c/c++的文件,文件头应该有类似这样的注释:
/********************************************************************
*
*  文件名:network.c
*
*  文件描述:网络通讯函数集
*
*  创建人: hao chen, 2003年2月3日
*
*  版本号:1.0
*
*  修改记录:
*
********************************************************************/

而对于函数来说,应该也有类似于这样的注释:

/*============================================================
*
* 函 数 名:xxx
*
* 参  数:
*
*    type name [in] : descripts
*
* 功能描述:
*
*    ..............
*
* 返 回 值:成功true,失败false
*
* 抛出异常:
*
* 作  者:chenhao 2003/4/2
*
============================================================*/

这样的描述可以让人对一个函数,一个文件有一个总体的认识,对代码的易读性和易维护性有很大的好处。这是好的作品产生的开始。


2、缩进、空格、换行、空行、对齐
----------------
i) 缩进应该是每个程序都会做的,只要学程序过程序就应该知道这个,但是我仍然看过不缩进的程序,或是乱缩进的程序,如果你的公司还有写程序不缩进的程序员,请毫不犹豫的开除他吧,并以破坏源码罪起诉他,还要他赔偿读过他程序的人的精神损失费。缩进,这是不成文规矩,我再重提一下吧,一个缩进一般是一个tab键或是4个空格。(最好用tab键)
ii) 空格。空格能给程序代来什么损失吗?没有,有效的利用空格可以让你的程序读进来更加赏心悦目。而不一堆表达式挤在一起。看看下面的代码:
  ha=(ha*128+*key++)%tabptr->size;
  ha = ( ha * 128 + *key++ ) % tabptr->size;
  有空格和没有空格的感觉不一样吧。一般来说,语句中要在各个操作符间加空格,函数调用时,要以各个参数间加空格。如下面这种加空格的和不加的:
  
if ((hproc=openprocess(process_all_access,false,pid))==null){
}
if ( ( hproc = openprocess(process_all_access, false, pid) ) == null ){
}
iii) 换行。不要把语句都写在一行上,这样很不好。如:
  for(i=0;i'9')&&(a[i]<'a'||a[i]>'z')) break;
  
  这种即无空格,又无换行的程序在写什么啊?加上空格和换行吧。  
  
  for ( i=0; i     if ( ( a[i] < '0' || a[i] > '9' ) &&
       ( a[i] < 'a' || a[i] > 'z' ) ) {
      break;
    }
  }
  好多了吧?有时候,函数参数多的时候,最好也换行,如:
  createprocess(
         null,
         cmdbuf,
         null,
         null,
         binhh,
         dwcrtflags,
         envbuf,
         null,
         &sistartinfo,
         &prinfo
         );
  条件语句也应该在必要时换行:
  
  if ( ch >= '0' || ch <= '9' ||
     ch >= 'a' || ch <= 'z' ||
     ch >= 'a' || ch <= 'z' )
         
iv) 空行。不要不加空行,空行可以区分不同的程序块,程序块间,最好加上空行。如:
  handle hprocess;
  process_t procinfo;
  /* open the process handle */
  if((hprocess = openprocess(process_all_access, false, pid)) == null)
  {
    return lse_misc_sys;
  }
  memset(&procinfo, 0, sizeof(procinfo));
  procinfo.idproc = pid;
  procinfo.hdproc = hprocess;
  procinfo.misc |= mscava_proc;
  return(0);
         
v) 对齐。用tab键对齐你的一些变量的声明或注释,一样会让你的程序好看一些。如:
typedef struct _pt_man_t_ {
  int   numproc;  /* number of processes         */
  int   maxproc;  /* max number of processes       */
  int   numevnt;  /* number of events          */
  int   maxevnt;  /* max number of events        */
  handle* phndevnt;  /*

相关IC型号

热门点击

 

推荐技术资料

罗盘误差及补偿
    造成罗盘误差的主要因素有传感器误差、其他磁材料干扰等。... [详细]
版权所有:51dzw.COM
深圳服务热线:13692101218  13751165337
粤ICP备09112631号-6(miitbeian.gov.cn)
公网安备44030402000607
深圳市碧威特网络技术有限公司
付款方式


 复制成功!