C/C++程序员的编程修养

1、版权和版本

/************************************************************************
*
* 文件名：network.c
*
* 文件描述：网络通讯函数集
*
* 创建人：Hao Chen, 2003年2月3日
*
* 版本号：1.0
*
* 修改记录：
*
************************************************************************/

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

/*================================================================
*
* 函 数 名：XXX
*
* 参 数：
*
* type name [IN] : descripts
*
* 功能描述:
*
* ..............
*
* 返 回 值：成功TRUE，失败FALSE
*
* 抛出异常：
*
* 作 者：ChenHao 2003/4/2
*
================================================================*/

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

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;

3、程序注释

4、函数的[in][out]参数

FuncName(char* str)
{
  int len = strlen(str);
  .....
}

char*
GetUserName(struct user* pUser)
{
  return pUser->name;
}

5、对系统调用的返回进行判断

fp = fopen("log.txt", "a");
if ( fp == NULL ){
  printf("Error: open file error\n");
  return FALSE;
}

6、if 语句对出错的处理

if ( ch >= '0' && ch <= '9' ){
  /* 正常处理代码 */
}else{
  /* 输出错误信息 */
  printf("error ......\n");
  return ( FALSE );
}

if ( ch < '0' || ch > '9' ){
  /* 输出错误信息 */
  printf("error ......\n");
  return ( FALSE );
}
/* 正常处理代码 */
......

7、头文件中的#ifndef

#ifndef <标识>
#define <标识>

......
......

#endif

#ifndef _STDIO_H_
#define _STDIO_H_

......

#endif

8、在堆上分配内存

char *AllocStrFromStack()
{
  char pstr[100];
  return pstr;
}

char *AllocStrFromHeap(int len)
{
  char *pstr;
  if ( len <= 0 ) return NULL;
    return ( char* ) malloc( len );
}

1. 配对使用，有一个malloc，就应该有一个free。（C++中对应为new和delete）
2. 尽量在同一层上使用，不要像上面那种，malloc在函数中，而free在函数外。最好在同一调用层上使用这两个函数。
3. malloc分配的内存一定要初始化。free后的指针一定要设置为NULL。

9、变量的初始化

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文件的使用

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",
  ......
  ......
};

备注

11、出错信息的处理

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()");
}
...
}

12、常用函数和循环语句中的被计算量

for( i=0; i<1000; i++ ){
  GetLocalHostName( hostname );
  ...
}

GetLocalHostName(char* name)
{
  char funcName[] = "GetLocalHostName";

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

13、函数名和变量名的命名

1. 直观并且可以拼读，可望文知意，不必“解码”。
2. 名字的长度应该即要最短的长度，也要能最大限度的表达其含义。
3. 不要全部大写，也不要全部小写，应该大小写都有，如：GetLocalHostName 或是 UserAccount。
4. 可以简写，但简写得要让人明白，如：ErrorCode -> ErrCode, ServerListener -> ServLisner，UserAccount -> UsrAcct 等。
5. 为了避免全局函数和变量名字冲突，可以加上一些前缀，一般以模块简称做为前缀。
6. 全局变量统一加一个前缀或是后缀，让人一看到这个变量就知道是全局的。
7. 用匈牙利命名法命名函数参数，局部变量。但还是要坚持“望文生意”的原则。
8. 与标准库（如：STL）或开发库（如：MFC）的命名风格保持一致。

14、函数的传值和传指针

void GetVersion(char* pStr)
{
  pStr = malloc(10);
  strcpy ( pStr, "2.0" );
}

main()
{
  char* ver = NULL;
  GetVersion ( ver );
  ...
  ...
  free ( ver );
}

15、修改别人程序的修养

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

if ( ( ch[0] >= '0' || ch[0] <= '9' ) &&
   ( ch[1] >= 'a' || ch[1] <= 'z' ) &&
   ( ch[2] >= 'A' || ch[2] <= 'Z' ) )

18、函数参数中的const

19、函数的参数个数（多了请用结构）

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

21、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 ){
    goto ErrHandle;
  }

  ......


  ErrHandle:
  FREE(fname);
  FREE(lname);
  FREE(mname);
  ReportError(ERR_NO_MEMOEY);
}

22、宏的使用

#define MAX(a, b) a>b?a:b

#define MAX( (a), (b) ) (a)>(b)?(a):(b)

23、static的使用

char*
getConsumerName()
{
  static int cnt = 0;

  ....
  cnt++;
....
}

24、函数中的代码尺寸

25、typedef的使用

typedef char bool;

#ifdef SOLARIS2_5
typedef boolean_t BOOL_T;
#else
typedef int BOOL_T;
#endif

typedef short INT16_T;
typedef unsigned short UINT16_T;
typedef int INT32_T;
typedef unsigned int UINT32_T;

#ifdef WIN32
typedef _int64 INT64_T;
#else
typedef long long INT64_T;
#endif

typedef float FLOAT32_T;
typedef char* STRING_T;
typedef unsigned char BYTE_T;
typedef time_t TIME_T;
typedef INT32_T PID_T;

typedef struct _hostinfo {
  HOSTID_T host;
  INT32_T hostId;
  STRING_T hostType;
  STRING_T hostModel;
  FLOAT32_T cpuFactor;
  INT32_T numCPUs;
  INT32_T nDisks;
  INT32_T memory;
  INT32_T swap;
} HostInfo;


typedef INT32_T (*RsrcReqHandler)(
  void *info,
  JobArray *jobs,
  AllocInfo *allocInfo,
  AllocList *allocList);

typedef CArray<HostInfo, HostInfo&> HostInfoArray;

HostInfo* phinfo;
RsrcReqHandler* pRsrcHand;

26、为常量声明宏

int user[120];

for ( i=0; i<120; i++){
  ....
}

#define MAX_USR_CNT 120

for ( i=0; i<MAX_USER_CNT; i++){
  ....
}

27、不要为宏定义加分号

#define MAXNUM 1024;

half = MAXNUM/2;

if ( num < MAXNUM )

half = 1024;/2;

if ( num < 1024; )

#define LINE "================================="

#define PRINT_LINE printf(LINE)

#define PRINT_NLINE(n) while ( n-- >0 ) { PRINT_LINE; }

main()
{
  char *p = LINE;
  PRINT_LINE;
}

28、||和&&的语句执行顺序

express1 || express2

express1 && express2

if ( sum > 100 &&
( ( fp=fopen( filename,"a" ) ) != NULL ) {

  fprintf(fp, "Warring: it beyond one hundred\n");
  ......
}

fprintf( fp, " sum is %id \n", sum );
fclose( fp );

if ( ( p != NULL ) && ( strlen(p) != 0 ))

29、尽量用for而不是while做循环

p = pHead;

while ( p ){
  ...
  ...
  p = p->next;
}

for ( p=pHead; p; p=p->next ){
  ..
}

30、请sizeof类型而不是变量

int score[100];
char filename[20];
struct UserInfo usr[100];

pScore = (int*) malloc( SUBJECT_CNT );
memset( pScore, 0, sizeof(pScore) );
...

对于score：sizeof(int) * 100 /* 100个int */
对于filename：sizeof(char) * 20 /* 20个char */
对于usr：sizeof(struct UserInfo) * 100 /* 100个UserInfo */

/*
* 分配一个有20个字符串，
* 每个字符串长100的内存
*/

char* *p;

/*
* 错误的分配方法
*/
p = (char**)calloc( 20*100, sizeof(char) );


/*
* 正确的分配方法
*/
p = (char**) calloc ( 20, sizeof(char*) );
for ( i=0; i<20; i++){
  /*p = (char*) calloc ( 100, sizeof(char) );*/
  p[i] = (char*) calloc ( 100, sizeof(char) );
}

31、不要忽略Warning

32、书写Debug版和Release版的程序

#ifdef DEBUG void TRACE(char* fmt, ...) { ...... 
} #else #define TRACE(char* fmt, ...) #endif

cc -DDEBUG -o target target.c

• 1、程序代码的易读性。
• 2、程序代码的可维护性，
• 3、程序代码的稳定可靠性。

薪酬最高的编程语言居然是？

谷歌发布新编程语言，居然专治这个？

10 本最佳 Linux、UNIX 编程书籍

快来看；2021 年最流行的 8 种编程语言！

常见代码重构技巧（非常实用）

支持下