長(zhǎng)文總結(jié)C/C++編碼準(zhǔn)則

對(duì)于一些技術(shù)細(xì)節(jié)來說和底層的技術(shù)，只要看幫助，查資料就能找到，對(duì)于速度快，只要編得多也就熟能生巧了。

我認(rèn)為好的程序員應(yīng)該有以下幾方面的素質(zhì)：

1、有專研精神，勤學(xué)善問、舉一反三。

2、積極向上的態(tài)度，有創(chuàng)造性思維。

3、與人積極交流溝通的能力，有團(tuán)隊(duì)精神。

4、謙虛謹(jǐn)慎，戒驕戒燥。

5、寫出的代碼質(zhì)量高。 包括：代碼的穩(wěn)定、易讀、規(guī)范、易維護(hù)、專業(yè)。

這些都是程序員的修養(yǎng)，這里我想談?wù)劇?a target="_blank">編程修養(yǎng)”，也就是上述中的第5點(diǎn)。 我覺得，如果我要了解一個(gè)作者，我會(huì)看他所寫的小說，如果我要了解一個(gè)畫家，我會(huì)看他所畫的圖畫，如果我要了解一個(gè)工人，我會(huì)看他所做出來的產(chǎn)品。

同樣，如果我要了解一個(gè)程序員，我想首先我最想看的就是他的程序代碼，程序代碼可以看出一個(gè)程序員的素質(zhì)和修養(yǎng)，程序就像一個(gè)作品，有素質(zhì)有修養(yǎng)的程序員的作品必然是一圖精美的圖畫，一首美妙的歌曲，一本賞心悅目的小說。

我看過許多程序，沒有注釋，沒有縮進(jìn)，胡亂命名的變量名，等等，等等，我把這種人統(tǒng)稱為沒有修養(yǎng)的程序，這種程序員，是在做創(chuàng)造性的工作嗎？ 不，完全就是在搞破壞，他們與其說是在編程，還不如說是在對(duì)源程序進(jìn)行“加密”，這種程序員，見一個(gè)就應(yīng)該開除一個(gè)，因?yàn)樗幍某绦蛩鶆?chuàng)造的價(jià)值，遠(yuǎn)遠(yuǎn)小于需要在上面進(jìn)行維護(hù)的價(jià)值。

程序員應(yīng)該有程序員的修養(yǎng)，那怕再累，再?zèng)]時(shí)間，也要對(duì)自己的程序負(fù)責(zé)。 我寧可要那種動(dòng)作慢，技術(shù)一般，但有良好的寫程序風(fēng)格的程序員，也不要那種技術(shù)強(qiáng)、動(dòng)作快的“搞破壞”的程序員。

有句話叫“字如其人”，我想從程序上也能看出一個(gè)程序員的優(yōu)劣。 因?yàn)?，程序是程序員的作品，作品的好壞直接關(guān)系到程序員的聲譽(yù)和素質(zhì)。 而“修養(yǎng)”好的程序員一定能做出好的程序和軟件。

有個(gè)成語叫“獨(dú)具匠心”，意思是做什么都要做得很專業(yè)，很用心，如果你要做一個(gè)“匠”，也就是造詣高深的人，那么，從一件很簡(jiǎn)單的作品上就能看出你有沒有“匠”的特性，我覺得做一個(gè)程序員不難，但要做一個(gè)“程序匠”就不簡(jiǎn)單了。 編程序很簡(jiǎn)單，但編出有質(zhì)量的程序就難了。

我在這里不討論過深的技術(shù)，我只想在一些容易讓人忽略的東西上說一說，雖然這些東西可能很細(xì)微，但如果你不注意這些細(xì)微之處的話，那么他將會(huì)極大的影響你的整個(gè)軟件質(zhì)量，以及整個(gè)軟件程的實(shí)施，所謂“千里之堤，毀于蟻穴”。

“細(xì)微之處見真功”，真正能體現(xiàn)一個(gè)程序的功底恰恰在這些細(xì)微之處。

這就是程序員的——編程修養(yǎng)。 我總結(jié)了在用C/C++語言（主要是C語言）進(jìn)行程序?qū)懽魃系娜€(gè)“修養(yǎng)”，通過這些，你可以寫出質(zhì)量高的程序，同時(shí)也會(huì)讓看你程序的人漬漬稱道，那些看過你程序的人一定會(huì)說：“這個(gè)人的編程修養(yǎng)不錯(cuò)”。

1、版權(quán)和版本

好的程序員會(huì)給自己的每個(gè)函數(shù)，每個(gè)文件，都注上版權(quán)和版本。

對(duì)于C/C++的文件，文件頭應(yīng)該有類似這樣的注釋：

/************************************************************************
*
* 文件名：network.c
*
* 文件描述：網(wǎng)絡(luò)通訊函數(shù)集
*
* 創(chuàng)建人：Hao Chen, 2003年2月3日
*
* 版本號(hào)：1.0
*
* 修改記錄：
*
************************************************************************/


而對(duì)于函數(shù)來說，應(yīng)該也有類似于這樣的注釋：


/*================================================================
*
* 函 數(shù) 名：XXX
*
* 參 數(shù)：
*
* type name [IN] : descripts
*
* 功能描述:
*
* ..............
*
* 返 回 值：成功TRUE，失敗FALSE
*
* 拋出異常：
*
* 作 者：ChenHao 2003/4/2
*
================================================================*/

2、縮進(jìn)、空格、換行、空行、對(duì)齊

i) 縮進(jìn)

應(yīng)該是每個(gè)程序都會(huì)做的，只要學(xué)程序過程序就應(yīng)該知道這個(gè)，但是我仍然看過不縮進(jìn)的程序，或是亂縮進(jìn)的程序，如果你的公司還有寫程序不縮進(jìn)的程序員，請(qǐng)毫不猶豫的開除他吧，并以破壞源碼罪起訴他，還要他賠償讀過他程序的人的精神損失費(fèi)。

縮進(jìn)，這是不成文規(guī)矩，我再重提一下吧，一個(gè)縮進(jìn)一般是一個(gè)TAB鍵或是4個(gè)空格。 （最好用TAB鍵）

ii) 空格

空格能給程序帶來什么損失嗎？ 沒有，有效的利用空格可以讓你的程序讀進(jìn)來更加賞心悅目。 而不一堆表達(dá)式擠在一起。 看看下面的代碼：

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;iif((a[i]<'0'||a[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' )

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、函數(shù)的[in][out]參數(shù)

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


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

5、對(duì)系統(tǒng)調(diào)用的返回進(jìn)行判斷

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

6、if 語句對(duì)出錯(cuò)的處理

if ( ch >= '0' && ch <= '9' ){
  /* 正常處理代碼 */
}else{
  /* 輸出錯(cuò)誤信息 */
  printf("error ......
");
  return ( FALSE );
}

if ( ch < '0' || ch > '9' ){
  /* 輸出錯(cuò)誤信息 */
  printf("error ......
");
  return ( FALSE );
}
/* 正常處理代碼 */
......

7、頭文件中的#ifndef

#ifndef <標(biāo)識(shí)>
#define <標(biāo)識(shí)>


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


#endif

#ifndef _STDIO_H_
#define _STDIO_H_


......


#endif

8、在堆上分配內(nèi)存

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

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

• 配對(duì)使用，有一個(gè)malloc，就應(yīng)該有一個(gè)free。（C++中對(duì)應(yīng)為new和delete）
• 盡量在同一層上使用，不要像上面那種，malloc在函數(shù)中，而free在函數(shù)外。最好在同一調(diào)用層上使用這兩個(gè)函數(shù)。
• malloc分配的內(nèi)存一定要初始化。free后的指針一定要設(shè)置為NULL。

• 對(duì)malloc分配的內(nèi)存進(jìn)行memset清零操作。（可以使用calloc分配一塊全零的內(nèi)存）
• 對(duì)一些棧上分配的struct或數(shù)組進(jìn)行初始化。（最好也是清零）

char *pstr; /* 一個(gè)字符串 */
pstr = ( char* ) malloc( 50 );
if ( pstr == NULL ) exit(0);
strcpy( pstr, "Hello Wrold" );

char **pstr; /* 一個(gè)字符串?dāng)?shù)組 */
pstr = ( char** ) malloc( 50 );
if ( pstr == NULL ) exit(0);


/* 讓數(shù)組中的指針都指向NULL */
memset( pstr, 0, 50*sizeof(char*) );

Links *plnk = NULL; /* 對(duì)于全局變量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、出錯(cuò)信息的處理

if ( p == NULL ){
  printf ( "ERR: The pointer is NULL
" );
}

/* 聲明出錯(cuò)代碼 */
#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 */


/* 聲明出錯(cuò)信息 */
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",
};


/* 聲明錯(cuò)誤代碼全局變量 */
long errno = 0;


/* 打印出錯(cuò)信息函數(shù) */
void perror( char* info)
{
  if ( info ){
    printf("%s: %s
", info, errmsg[errno] );
    return;
  }
  printf("Error: %s
", 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' ) )

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

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

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

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


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

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

HostInfo* phinfo;
RsrcReqHandler* pRsrcHand;

int user[120];

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

#define MAX_USR_CNT 120


for ( i=0; i
  ....
}

#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;
}

express1 || express2

express1 && express2

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


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


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

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

p = pHead;


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

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

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

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

對(duì)于score：sizeof(int) * 100 /* 100個(gè)int */
對(duì)于filename：sizeof(char) * 20 /* 20個(gè)char */
對(duì)于usr：sizeof(struct UserInfo) * 100 /* 100個(gè)UserInfo */

/*
* 分配一個(gè)有20個(gè)字符串，
* 每個(gè)字符串長(zhǎng)100的內(nèi)存
*/


char* *p;


/*
* 錯(cuò)誤的分配方法
*/
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) );
}

#ifdef DEBUG 
void TRACE(char* fmt, ...) 
{ ...... 


} 
#else 
#define TRACE(char* fmt, ...) 
#endif

cc -DDEBUG -o target target.c