C/C++编码准则，可借鉴的东西还挺多！

/************************************************************************

*

* 文件名：network.c

*

* 文件描述：网络通讯函数集

*

* 创建人：Hao Chen, 2003年2月3日

*

* 版本号：1.0

*

* 修改记录：

*

************************************************************************/



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



/*================================================================

*

* 函 数 名：XXX

*

* 参 数：

*

* type name [IN] : descripts

*

* 功能描述:

*

* ..............

*

* 返 回 值：成功TRUE，失败FALSE

*

* 抛出异常：

*

* 作 者：ChenHao 2003/4/2

*

================================================================*/

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 ){

}

for(i=0;i<len;i++) if((a[i]<'0'||a[i]>'9')&&(a[i]<'a'||a[i]>'z')) 

for ( i=0; i<len; 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' )

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);

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; /* Array of events */

  DWORD timeout; /* Time out interval */

  HANDLE hPipe; /* Namedpipe */

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

  int numMsg; /* Number of Message */

  int Msg[MAXMSG];/* Space for intro process communicate */

} PT_MAN_T;

FuncName(char* str)

{

  int len = strlen(str);

  .....

}



char*

GetUserName(struct user* pUser)

{

  return pUser->name;

}

fp = fopen("log.txt", "a");

if ( fp == NULL ){

  printf("Error: open file error\n");

  return FALSE;

}

if ( ch >= '0' && ch <= '9' ){

  /* 正常处理代码 */

}else{

  /* 输出错误信息 */

  printf("error ......\n");

  return ( FALSE );

}

if ( ch < '0' || ch > '9' ){

  /* 输出错误信息 */

  printf("error ......\n");

  return ( FALSE );

}

/* 正常处理代码 */

......

#ifndef <标识>

#define <标识>



......

......



#endif

#ifndef _STDIO_H_

#define _STDIO_H_



......



#endif

char *AllocStrFromStack()

{

  char pstr[100];

  return pstr;

}

char *AllocStrFromHeap(int len)

{

  char *pstr;

  if ( len <= 0 ) return NULL;

    return ( char* ) malloc( len );

}

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 */

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 */ "Permission denied",

  /* 9 */ "Bad configuration file format",

  /* 10 */ "Communication time out",

  ......

  ......

};

if ( p == NULL ){

  printf ( "ERR: The pointer is NULL\n" );

}

/* 声明出错代码 */

#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 */ "Permission 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] );

}

bool CheckPermission( char* userName )

{

  if ( strcpy(userName, "root") != 0 ){

  errno = ERR_PERMISSION_DENIED;

  return (FALSE);

}



...

}



main()

{

  ...

  if (! CheckPermission( username ) ){

  perror("main()");

}

...

}

for( i=0; i<1000; i++ ){

  GetLocalHostName( hostname );

  ...

}

GetLocalHostName(char* name)

{

  char funcName[] = "GetLocalHostName";



  sys_log( "%s begin......", funcName );

  ...

  sys_log( "%s end......", funcName );

}

void GetVersion(char* pStr)

{

  pStr = malloc(10);

  strcpy ( pStr, "2.0" );

}



main()

{

  char* ver = NULL;

  GetVersion ( ver );

  ...

  ...

  free ( ver );

}

/*

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

/* ---------------------------------------- */

...

if ( ( ch[0] >= '0' || ch[0] <= '9' ) &&

   ( ch[1] >= 'a' || ch[1] <= 'z' ) &&

   ( ch[2] >= 'A' || ch[2] <= 'Z' ) )