搜索
您的当前位置:首页正文

四级上机编程修养

来源:二三娱乐

  ———————

  好的程序员会给自己的每个函数,每个文件,都注上版权和版本。

  对于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 |= MSC***A_PROC;

  return(0);

  v) 对齐。用TAB键对齐你的一些变量的声明或注释,一样会让你的程序好看一些。如:

  typedef struct _pt_man_t_ {

  int numProc; /* Number of processes */

  int maxProc; /* Max Number of processes */

  int maxProc; /* Max Number of processes */

  int numEvnt; /* Number of events */

  int maxEvnt; /* Max Number of events */

  HANDLE* pHndEvnt; /* Array of events */

  DWORD timeout; /* Time out interval */

  HANDLE hPipe; /* Namedpipe */

  TCHAR usr[MAXUSR];/* User name of the process */

Top