C 語言新手十誡

The Ten Commandments for Newbie C Programmers
－－－－－－－－－－－－－－－－－－－－－－－by Khoguan Phuann

請注意：

(1) 本篇旨在提醒新手，避免初學常犯的錯誤（其實老手也常犯:-Q)。但不能取代完整的學習，請自己好好研讀一兩本 C 語言的好書，並多多實作練習。

(2) 強烈建議新手先看過此文再發問，你的問題極可能此文已經提出並解答了。

(3) 以下所舉的錯誤例子如果在你的電腦上印出和正確例子相同的結果，那只是不足為恃的一時僥倖。

(4) 不守十誡者，輕則執行結果的輸出數據錯誤，或是程式當掉，重則引爆核彈、毀滅地球（如果你的 C 程式是用來控制核彈發射器的話）。

一、你不可以使用尚未給予適當初值的變數。

錯誤例子：
int accumulate(int max) /* 從 1 累加到 max，傳回結果 */
{
int sum; /* 未給予初值的區域變數，其內容值是垃圾 */
int num;
for (num = 1; num <= max; num++) {
sum += num;
}
return sum;
}

正確例子：
int accumulate(int max)
{
int sum = 0; /* 正確的賦予適當的初值 */
int num;
for (num = 1; num <= max; num++) {
sum += num;
}
return sum;
}

二、你不可以存取超過陣列既定範圍的空間。

錯誤例子：
int str[5];
int i;
for (i = 0; i <= 5; i++) str[i] = i;

正確例子：
int str[5];
int i;
for (i = 0; i < 5; i++) str[i] = i;

說明：宣告陣列時，所給的陣列元素個數值如果是 N, 那麼我們在後面
透過 [索引值] 存取其元素時，所能使用的索引值範圍是從 0 到 N-1,
也就是 C 和 C++ 的陣列元素是從第 0 個開始算起，最後一個元素的
索引值是 N-1, 不是 N。

C/C++ 為了執行效率，並不會自動檢查陣列索引值是否超過陣列邊界，
我們要自己寫程式來確保不會越界。一旦越界，將導致無法預期的後果。

三、你不可以提取(dereference)不知指向何方的指標（包含 null 指標）。

錯誤例子：
char *pc1; /* 未給予初值，不知指向何方 */
char *pc2 = 0; /* pc2 起始化為 null pointer */
*pc1 = ‘a’; /* 將 ‘a’ 寫到不知何方，錯誤 */
*pc2 = ‘b’; /* 將 ‘b’ 寫到「位址0」，錯誤 */

正確例子：
char c; /* c 的內容尚未起始化 */
char *pc1 = &c; /* pc1 指向字元變數 c */

/* 動態分配 10 個 char(其值未定),並將第一個char的位址賦值給 pc2 */
char *pc2 = (char *)malloc(10);
*pc1 = ‘a’; /* c 的內容變為 ‘a’ */
pc2[0] = ‘b’; /* 動態配置來的第 0 個字元，內容變為 ‘b’
/* 最後記得 free() 掉 malloc() 所分配的空間 */
free(pc2);

說明：指標變數必需先指向某個明確的東西(object)，才能進行操作。

四、你不可以將字串常數賦值(assign)給 char* 變數，然後透過該變數改寫字串的內容（只能讀不能寫）。

錯誤例子：
char *pc = “john"
*pc = ‘J’;
printf(“Hello, %s\n", pc);

正確例子：
char pc[] = “john"
*pc = ‘J’; /* 或 pc[0] = ‘J’; */
printf(“Hello, %s\n", pc);

說明：字串常數的內容是唯讀的。上面的錯誤例子，是將其內容所在的位址賦
值給字元指標 pc, 我們透過指標只可以去讀該字串常數的內容，而不應該做
寫入的動作。而正確例子，則是另外宣告一個獨立的字元陣列，它的大小我們
未明文指定（[]），編譯器會自動將其設為剛好可以容納後面的字串常數起始
值的大小，包括字串後面隱含的 " 字元，並將字串常數的內容複製到字元
陣列中，因此可以自由的對該字元陣列的內容進行讀和寫。

錯誤例子(2)：
char *s1 = “Hello, “
char *s2 = “world!"
/* strcat() 不會另行配置空間，只會將資料附加到 s1 所指唯讀字串的後面，
造成寫入到程式無權碰觸的記憶體空間 */
char *s3 = strcat(s1, s2);

正確例子(2)：
/* s1 宣告成陣列，並保留足夠空間存放後續要附加的內容 */
char s1[20] = “Hello, “
char *s2 = “world!"
/* 因為 strcat() 的返回值等於第一個參數值，所以 s3 就不需要了 */
strcat(s1, s2);

五、你不可以對尚未分配所指空間的 char* 變數，進行(字串)陣列的相關操作。其他型別的指標亦然。

錯誤例子：
char *name; /* name 尚未指向有效的空間 */
printf(“Your name, please: “);
gets(name);
printf(“Hello, %s\n", name);

正確例子(1)：
/* 如果編譯期就能決定字串的最大空間，那就不要宣告成 char* 改用 char[] */
char name[21]; /* 字串最長 20 個字元，另加一個 " */
printf(“Your name, please: “);
gets(name);
printf(“Hello, %s\n", name);

正確例子(2)：
/* 若是在執行時期才能決定字串的最大空間，則需利用 malloc() 函式來動態
分配空間 */

size_t length;
char *name;
printf(“請輸入字串的最大長度(含null字元): “);
scanf(“%u", &length);
name = (char *)malloc(length);
printf(“Your name, please: “);
scanf(“%s", name);
printf(“Hello, %s\n", name);
/* 最後記得 free() 掉 malloc() 所分配的空間 */
free(name);

注意：上例用 gets() 或 scanf() 來讀入字串，是不安全的。 因為這些函式
不會幫我們檢查使用者所輸入的字串長度是否超過我們所分配的 buffer 空間，
很可能會發生 buffer overflow。比較安全的做法是用 fgets() 來取代。如：

char *p;
char name[21];
printf(“Your name, please: “);
fgets(name, sizeof(name), stdin);
/* fgets()會連行末的’\n’也讀進字串中，所以要找出存入’\n’的位置，填入 “
if ((p = strchr(name, ‘\n’)) != NULL)
*p = “;
printf(“Hello, %s\n", name);

六、你不可以在函式中回傳一個指向區域性自動變數的指標。否則，會得到垃圾值。
[感謝 gocpp 網友提供程式例子]

錯誤例子：
char *getstr(char *name)
{
char buf[30] = “hello, " /*將字串常數"hello, “的內容複製到buf陣列*/
strcat(buf, name);
return buf;
}

說明：區域性自動變數，將會在離開該區域時(本例中就是從getstr函式返回時)
被消滅，因此呼叫端得到的指標所指的字串內容就失效了。【不過，倒是可以從
函式中直接傳回字串常數，賦值給呼叫端的一個 const char * 變數，它既是唯
讀的（參見第四誡），同時也具有恒常的儲存期(static storage duration),其
內容將一直有效。】

正確例子：
void getstr(char buf[], int buflen, char const *name)
{
char const s[] = “hello, “
assert(strlen(s) + strlen(name) < buflen);

strcpy(buf, s);
strcat(buf, name);
}

[針對字串操作，C++提供了更方便安全的 string class, 能用就盡量用]
#include <string>
using std::string;

string getstr(string const &name)
{
return string(“hello, “) += name;
}

七、你不可以只做 malloc(), 而不做相應的 free(). 否則會造成記憶體漏失。

但若不是用 malloc() 所得到的記憶體，則不可以 free()。已經 free()了
所指記憶體的指標，在它指向另一塊有效的動態分配得來的空間之前，不可
以再被 free()，也不可以提取(dereference)這個指標。

[C++] 你不可以只做 new, 而不做相應的 delete.

八、你不可以在數值運算、賦值或比較中隨意混用不同型別的數值，而不謹慎考慮數值型別轉換可能帶來的「意外驚喜」（錯愕）。必須隨時注意數值運算的結果，其範圍是否會超出變數的型別。

錯誤例子(1)：
unsigned int sum = 2000000000 + 2000000000; /* 20 億 */
double f = 10 / 3;

正確例子(1)：
/* 全部都用 unsigned int, 注意數字後面的 u, 大寫 U 也成 */
unsigned int sum = 2000000000u + 2000000000u;

/* 或是用顯式的轉型 */
unsigned int sum = (unsigned int)2000000000 + 2000000000;

double f = 10.0 / 3.0;

說明：在目前最普遍的32位元PC作業平台上，整數常數2000000000的型別為
signed int(簡寫為 int)，相加後，其結果仍為 int, 但是 signed int
放不下 4000000000, 造成算術溢位(arithmetic overflow)，很可能無法
將正確的值指派給 unsigned int sum，縱使 unsigned int 放得下4000000000
的數值。注意：寫成

unsigned int sum = (unsigned int)(2000000000 + 2000000000);

也是不對的。

例子(2)：（感謝 sekya 網友提供）
unsigned char a = 0×80;
char b = 0×80; /* implementation-defined result */
if( a == 0×80 ) { /* 恒真 */
printf( “a ok\n" );
if( b == 0×80 ) { /* 不一定恒真 */
printf( “b ok\n" );
}

說明：在將 char 型別定義為範圍從 -128 至 +127 的系統上，int 0×80
（其值等於 +128）要轉成 char 會放不下，會產生編譯器自行定義的值。
這樣的程式就不具可移植性了。

九、你不可以在一個運算式(expression)中，對一個基本型態的變數修改其值超過一次以上。否則，將導致未定義的行為(undefined behavior)。

錯誤例子：
int i = 7;
int j = ++i + i++;

正確例子：
int i = 7;
int j = ++i;
j += i++;

你也不可以在一個運算式(expression)中，對一個基本型態的變數修改其值，
而且還在同一個式子的其他地方為了其他目的而存取該變數的值。（其他目的，
是指不是為了計算這個變數的新值的目的）。否則，將導致未定義的行為。

錯誤例子：
int arr[5];
int i = 0;
arr[i] = i++;

正確例子：
int arr[5];
int i = 0;
arr[i] = i;
i++;

[C++程式]
錯誤例子：
int i = 10;
cout << i << “==" << i++;

正確例子：
int i = 10;
cout << i << “=="
cout << i++;

十、你不可以在macro的定義中，不為它的參數個別加上括號。

錯誤例子：
#include <stdio.h>
#define SQUARE(x) (x * x)
int main()
{
printf(“%d\n", SQUARE(10-5));
return 0;
}

正確例子：
#include <stdio.h>
#define SQUARE(x) ((x) * (x))
int main()
{
printf(“%d\n", SQUARE(10-5));
return 0;
}

說明：如果是用 C++, 請多多利用 inline function 來取代上述的 macro,
以免除 macro 定義的種種危險性。如：

inline int square(int x) { return x * x; }

macro 定義出的「偽函式」至少缺乏下列數項函式本有的能力：

(1) 無法進行參數型別的檢查。
(2) 無法遞迴呼叫。
(3) 無法用 & 加在 macro name 之前，取得函式位址。
(4) 呼叫時往往不能使用具有 side effect 的引數。例如：

錯誤例子：（感謝 yaca 網友提供）
#define MACRO(x) (((x) * (x)) – ((x) * (x)))
int main()
{
int x = 3;
printf(“%d\n", MACRO(++x));
return 0;
}

MACRO(++x) 展開來後變成 (((++x) * (++x)) – ((++x) * (++x)))
違反了第九誡。在 gcc 4.3.3 下的結果是 -24, 在 vc++ 下是 0.

後記：從「古時候」流傳下來一篇文章

“The Ten Commandments for C Programmers"(Annotated Edition)
by Henry Spencer

http://www.lysator.liu.se/c/ten-commandments.html

一方面它不是針對 C 的初學者，一方面它特意模仿中古英文聖經的用語，寫得文謅謅。所以我現在另外寫了這篇，希望能涵蓋最重要的觀念以及初學甚至老手最易犯的錯誤。

作者：潘科元(Khoguan Phuann) (c)2005. 感謝 ptt.cc BBS 的 C_and_CPP看板眾多網友提供寶貴意見及程式實例。

Forward from PTT – C_and_CPP 板

fopen( ) 檔案存取模式

存取模式	代碼	說明
讀取資料	r	開啟一個只可以讀取資料的檔案。 如果檔案不存在，則fopen( )開檔失敗，無法執行。
寫入資料	w	開啟一個只可以寫入資料的檔案。 如果檔案已存在，則該檔案的內容將被覆蓋掉。 如果檔案不存在，則系統會自行建立此檔案。
附加於檔案之後	a	開啟一個檔案，將資料寫入檔案的末端。 如果檔案不存在，則系統會自行建立此檔案。
寫入舊檔	r+	開啟一個可以讀取與寫入資料的已存在檔案。 如果檔案不存在，則fopen( )開檔失敗，無法執行。
新檔讀寫	w+	開啟一個可以讀取與寫入資料的新檔案。 如果檔案已存在，檔案的內容將被覆蓋掉。 如果檔案不存在，系統會自行建立檔案。
讀取與附加	a+	開啟一個可以讀取或附加資料的檔案。 如果檔案不存在，系統會自行建立此檔案。
二進位檔讀取	rb	開啟一個僅供讀取資料的二進位檔案。
二進位檔寫入	wb	開啟一個僅供寫入資料的二進位檔案。
二進位檔附加	ab	開啟一個僅供附加資料的二進位檔案。

使用 sprintf( ) 將數字轉成字串

在 C 語言中可以呼叫 atoi( ) 將字串轉成數字；

但要將數字轉成字串的話並沒有內建的函數可以使用，
也許有人會建議可以使用 itoa( )  函數，
但 itoa( ) 並非標準函式庫，必須引用 Borland C/C++ 自行定義的 conio.h
所以在像 Unix/Linux 等環境便派不上用場。

但其實可以透過 sprintf( ) 來幫你把數字填到字串中：

#include <stdio.h>
#include <stdlib.h>

int main() {
－char *str;
－int num = 66;

－sprintf(str, “%d", num);
－printf(“str = %s\n", str);

－return(0);
}

使用 strncpy( ) 注意事項

由於 strncpy() 函數最初被設計為用來處理一種現在已經摒棄的舊式資料結構：
固定長度，不須以結尾字元 結束的字串。

所以 strncpy( ) 函數並不會自動幫你在目的字串加上結尾字元
因此最好養成習慣在呼叫 strncpy( ) 函數後，自己手動補上結尾字元。

否則等你發現是因為這個小細節導致程式執行有奇怪的異常狀況，往往是埋頭 debug 的時候了…

p.s. 或者可以自己改寫一個修正的函數如 strncpy_fix( )
－－或是使用其它的方法如 strncat( ) 或 sprintf( ) 來想辦法達到相同的效果。

奇妙的 Callback

#include <stdio.h>
－
struct table {
－char id;
－void *func;
};
－
void *funcA() { printf(“This is funcA()\n"); }
void *funcB() { printf(“This is funcB()\n"); }
void *funcC() { printf(“This is funcC()\n"); }
void *funcD() { printf(“This is funcD()\n"); }
－
const struct table tb[] = {
－{1, funcA},
－{2, funcB},
－{3, funcC},
－{4, funcD}
};
－
int main()
{
－int index, i;
－void (*func)(void);
－
－index = 1;
－
－for (i = 0; i < 4; i++) {
－－if (index == tb[i].id) func = tb[i].func;
－}

－func();
－
－return 0;
}

上面的小程式是 callback function 的簡單應用，
簡單的說 callback 的概念就是回傳某個函數的指標，
呼叫者便可透過這個函數指標直接執行函數…

至於 callback 和一般的函數呼叫有什麼不同，
就結果來看是一樣的：某個函數被呼叫然後執行。

而程式碼撰寫的語法、中間處理的過程卻不一樣，
callback 可以被應用在什麼地方？
什麼情況下用 callback 來設計程式會比較好？
目前道行尚淺，也許有朝一日可以得到答案吧。

條件式編譯指令的應用

開發大型的專案程式時，通常會使用到許多自訂的 header 檔案（*.h），
這些 header 檔案裡包含著許多自訂的資料結構或函式，
若在編譯整個專案的過程中要避免不同 header 檔案間有重覆定義的情況發生，
可以使用 #ifndef 指令作一些預防措拖：
（假設檔名為 math.h）

#ifndef MATH_H
#define MATH_H
－－：
－－：
#endif /* MATH_H */

－

另外一個實用的應用是 #define 和 #if 指令搭配使用，
來控制整個專案程式中的是否開啟 debug 訊息顯示：

#define DEBUG 1
－－：
－－：

#if DEBUG
－printf(“Show debug message!");
#endif

GCC 編譯時的 pack 設定

struct data {
－char a;
－int b;
－char c;
－double d;
－short e;
－char f;
}__attribute__ ((packed));

一個 struct 被編譯時內部成員變數的記憶體位址是由編譯器決定的，
像上面這個 struct 的話，所有成員變數的大小總和是：
char(1) + int(4) + char(1) + double(8) +short(2) = 16 bytes

但如果用一般的宣告方式沒加上 pack 語法設定的話，
編譯後整個 struct 的大小為 32 bytes，
所以每個成員變數被的記憶體定址並沒有完全連在一起，有部份空隙存在，
只要把每個成員變數的記憶體位址 print 出來看便一清二楚。

加上了 pack 語法設定再編譯後，
整個 struct 的大小為 16 bytes，就的確是每個成員變數的大小總和，
成員變數的記憶體定址也確實連接在一起沒有多餘的空隙。

字元字串的輸出輸入函數

getchar( )　　<stdio.h>
從鍵盤上輸入一個字元，所輸入的字元會立即顯示出來，按下 Enter 鍵後，這個字元才會被變數接收。

putchar( )　　<stdio.h>
將字元變數的內容列印在螢幕上。

getche( )　　<conio.h>
從鍵盤上輸入一個字元，輸入後不需要按下 Enter 鍵，剛才輸入的字元會立即顯示出來，變數也會馬上接收這個字元。

putch( )　　<conio.h>
將字元變數的內容列印在螢幕上。同 putchar( ) 函數。

getch( )　　<conio.h>
從鍵盤上輸入一個字元，不需要按下 Enter 鍵，變數會馬上接收這個字元，螢幕上也看不到這個被輸入的字元。

gets( )　　<stdio.h>
輸入字串時，按下 Enter 鍵後，才會接收字串並存放在指定的陣列中。而 scanf( ) 函數若是到空白字元就視為輸入結束。

puts( )　　<stdio.h>
會將字串結束字元 轉換成換行字元，因此在輸出一個字串後會自動換行。

運算子的優先順序

-優先須序-	運算子	類別
1	()	-括號運算
	[]	-方括號運算
	->	-箭號運算
2	-!+(正號)---(負號)-	-一元運算
	~	-位元邏輯運算
	++--–	-遞增、遞減運算
	*	-指標運算
	&	-位址運算
3	*--/--%	-算數運算
4	+---	-算數運算
5	<<-->>	-位元左移、右移運算--
6	>-->=--<<--=	-關係運算
7	==--!=	-關係運算
8	&(AND)	-位元邏輯運算
9	^(XOR)	-位元邏輯運算
10	|(OR)	-位元邏輯運算
11	&&	-邏輯運算
12	||	-邏輯運算
13	?:	-條件運算
14	=	-設定運算

printf( ) 的列印格式、控制字元、修飾子

- 列印格式-	-輸出敘述
%c	-字元
%s	-字串
%d	-十進位整數
%u	-無號十進位整數
%o	-無號八進位整數
%x	-無號十六進位整數，以 0 ~ f 表示
%X	-無號十六進位整數，以 0 ~ F 表示--
%f	-浮點數，小數點型式
%e	-浮點數，指數e型式
%E	-浮點數，指數E型式
%g	-印出 %f 與 %e 較短者
%G	-印出 %F 與 %E 較短者
%p	-指標位址
%%	-印出百分比符號

-

-控制字元--	-功能
\a	-警告音
\b	-倒退
\f	-換頁
\n	-換行
\r	-歸位
\t	-跳格
\’	-印出單引號
\"	-印出雙引號
\\	-反斜線
\/	-斜線
\d	-八進位 Ascii 碼
\x	-十六進位 Ascii 碼--

-

-修飾子-	-功能	-範例
-	-向左對齊	-%-3d
+	-將數值的正負號顯示出來	-%+5d
空白	-數值為正值時，留一格空白；為負值時，顯示負號	-% 6f
0	-將固定欄位長度的數值前空白處填上 0；與 – 修飾子同時使用時，此修飾子無效--	-%07.2f--
數字	-欄位長度，當數值的位數大於所定的欄位長度時，欄位會自動加寬它的長度	-%9d
.	-數值以 %e, %E, %f 型式表示時，決定小數點後所要顯示的位數	-%4.3f
h	-表示 short int 或是 unsigned short int	-%5h
l	-表示 long int 或是 unsigned long int	-%lu