從刻舟求劍的故事評析劣質(zhì)代碼
【題目】
將一個5*5的矩陣中***的元素中***的元素放在中心,4個角分別放4個最小的元素(順序為從左到右,從上到下依次從小到大存放),寫一函數(shù)實現(xiàn)之,用main函數(shù)調(diào)用。
——譚浩強 ,《C程序設(shè)計(第四版)學(xué)習輔導(dǎo)》,清華大學(xué)出版社,2010年7月,p108
【評析】
這其實是一個相當復(fù)雜的問題,題目作者自己大概根本沒意識到,更沒有真正想清楚這個問題的解決,拍拍腦袋就出題了。
題目中明顯的問題是語義不清,比如什么是“***”?什么是“最小”?什么是倒數(shù)第二小?這些含義都不明確。所以如果不進一步對問題進行補充說明,題目的解并不能保證唯一??蜌恻c說題目不嚴格,如果事實求是說,題目本身就是錯誤的。
例如,1、1、2、2、3、3這6個數(shù)中,究竟1是這組整數(shù)中第二小的數(shù),還是2是第二小的整數(shù)?這個問題的答案很可能有歧義,更有歧義的是究竟哪個位置上的數(shù)是第2小的數(shù)?
“寫一函數(shù)實現(xiàn)之”完全是一個過分的要求,也是一個外行的要求,就跟要求別人用腳指頭敲鍵盤一樣。
【原代碼】
- . #include <stdio.h>
- . int main()
- . {void change(int *p);
- . int a[5][5],*p,i,j;
- . printf("input matrix:\n");
- . for(i=0;i<5;i++)
- . for(j=0;j<5;j++)
- . scanf("%d",&a[i][j]);
- . p=&a[0][0];
- . change(p);
- . printf("Now matrix:\n");
- . for(i=0;i<5;i++)
- . {for(j=0;j<5;j++)
- . printf("%d ",a[i][j]);
- . printf("\n");
- . }
- . return 0;
- . }
- . void change(int *p)
- . {int i,j,temp;
- . int *pmax,*pmin;
- . pmax=p;
- . pmin=p;
- . for(i=0;i<5;i++)
- . for(j=i;j<5;j++)
- . {if(*pmax<*(p+5*i+j))pmax=p+5*i+j;
- . if(*pmin>*(p+5*i+j))pmin=p+5*i+j;
- . }
- . temp=*(p+12);
- . *(p+12)=*pmax;
- . *pmax=temp;
- . temp=*p;
- . *p=*pmin;
- . *pmin=temp;
- . pmin=p+1;
- . for(i=0;i<5;i++)
- . for(j=0;j<5;j++)
- . if(((p+5*i+j)!=p)&&(*pmin>*(p+5*i+j)))pmin=p+5*i+j;
- . temp=*pmin;
- . *pmin=*(p+4);
- . *(p+4)=temp;
- . pmin=p+1;
- . for(i=0;i<5;i++)
- . for(j=0;j<5;j++)
- . if(((p+5*i+j)!=(p+4))&&((p+5*i+j)!=p)&&(*pmin>*(p+5*i+j)))
- . pmin=p+5*i+j;
- . temp=*pmin;
- . *pmin=*(p+20);
- . *(p+20)=temp;
- . pmin=p+1;
- . for(i=0;i<5;i++)
- . for(j=0;j<5;j++)
- . if(((p+5*i+j)!=p)&&((p+5*i+j)!=(p+4))&&((p+5*i+j)!=(p+20))&&
- . (*pmin>*(p+5*i+j))) pmin=p+5*i+j;
- . temp=*pmin;
- . *pmin=*(p+24);
- . *(p+24)=temp;
- . }
——譚浩強 ,《C程序設(shè)計(第四版)學(xué)習輔導(dǎo)》,清華大學(xué)出版社,2010年7月,p109~110
【評析】
- . printf("input matrix:\n");
- . for(i=0;i<5;i++)
- . for(j=0;j<5;j++)
- . scanf("%d",&a[i][j]);
- . p=&a[0][0];
- . change(p);
- . printf("Now matrix:\n");
- . for(i=0;i<5;i++)
- . {for(j=0;j<5;j++)
- . printf("%d ",a[i][j]);
- . printf("\n");
- . }
不會寫代碼的人毛病,就是急著先把能寫的內(nèi)容一下子寫完。在這段代碼中可以看到change(p)像是掉進了一堆亂麻里的一只牙簽一樣,整個代碼的結(jié)構(gòu)亂作一團。這是一只很拙劣的風格,對比一下下面的寫法就知道這段代碼有多糟糕了。
- #include <stdio.h>
- int main( void )
- {
- int a[5][5] ;
- input(a,5);
- change(*a);
- output(a,5);
- return 0;
- }
哪個寫法清晰明了是一目了然的吧?
結(jié)構(gòu)化程序設(shè)計中有一條著名的原則,這就是自頂向下(Top Down),這個原則說的是先從大處著眼,把問題分解為若干小問題,然后再把這些小問題進一步分解為更小的問題,直到無法再分解為止。這叫逐步細化。
每一層分解都是一種抽象,抽象的目的是為了概括,概括的目的是為了有一個簡單的表現(xiàn)形式,從而把不必要的細節(jié)隱藏在這種簡單的表現(xiàn)形式的后面。函數(shù)是實現(xiàn)這種思想的利器。在每次的分解過程中,問題總是被分解為同一層次上的問題。這樣的代碼才可能具有優(yōu)雅的均衡感和良好的可讀性。
- p=&a[0][0];
- change(p);
是典型的多此一舉。因為p這個變量多余。這兩句話無非就是
- change(*a); //或change(a[0]); //或change(&a[0][0]);
而已。需要注意的是,change()函數(shù)要操作的是整個數(shù)組,而這里的實參僅僅是一個指向a[0][0]的指針。很顯然,change()得到的信息并不充分,它不可能知道它要操作的是一個int [5][5]類型的數(shù)組。換言之,chang()函數(shù)不可能完成任務(wù),除非它再通過別的歪門邪道獲得其他必要的信息。
下面考察chang()函數(shù)定義。
從沒見過這么丑的函數(shù)!居然能把函數(shù)寫得如此之丑,不禁嘆為奇跡。
- void change(int *p)
前面提到過,參數(shù)不完整。這注定后面要走歪門邪道(比如許多無厘頭的Magic Number)。
- for(i=0;i<5;i++)
- for(j=i;j<5;j++)
- {if(*pmax<*(p+5*i+j))pmax=p+5*i+j;
- if(*pmin>*(p+5*i+j))pmin=p+5*i+j;
- }
這段代碼試圖尋找***值與最小值的位置。但是正如前面討論過的那樣,***、最小值的位置可能不是唯一的。那么究竟要找的是哪一個呢?其實代碼作者自己也不知道,找到哪個算哪個,無頭蒼蠅撞大運。
這其中有一個明顯的錯誤,就是內(nèi)層for語句中的j=i。這表明它并不是在整個數(shù)組中尋找***最小值的位置,而只是在數(shù)組中的一個局部尋找***最小值的位置。這樣的代碼顯然是錯誤的。
即使改正了這個錯誤,從C語言的語法角度講,這段代碼也還是錯誤的。因為p是指向main()中a[0][0]的指針,而a[0][0]是一維數(shù)組a[0]的一個元素。根據(jù)C語言的規(guī)則,這個p做加減法得到的結(jié)果必須依然指向a[0]中的元素或者a[0]中***一個元素的下一個位置,否則代碼行為是未定義的。而在p+5*i+j這個表達式中,由于5*i+j的值可能大于5,所以是未定義行為。所謂未定義行為通俗地來說就是,C語言并沒有承諾這樣寫會得到什么,這樣的代碼可能得到任何結(jié)果。就像瘋子的胡言亂語可以隨意解釋一樣。
即使拋開前面一系列錯誤不談,后面的代碼依然是錯誤的:
- temp=*(p+12);
- *(p+12)=*pmax;
- *pmax=temp;
- temp=*p;
- *p=*pmin;
- *pmin=temp;
這里,代碼把pmax所指向的數(shù)據(jù)對象與p+12(這個表達式本身就不靠譜)所指向的數(shù)據(jù)對象交換,然后又把pmin所指向的數(shù)據(jù)對象與p所指向的數(shù)據(jù)對象交換。但是代碼作者忘記了,pmin所指向的位置可能恰恰是p+12所指向的位置,在這種情況下,第二次交換就是***元素與p指向的元素的交換,而非所期待的最小元素與*p的交換,這樣得到的結(jié)果顯然是錯誤的。在這里代碼作者犯了中國古代寓言“刻舟求劍”中一模一樣的錯誤。古希臘哲學(xué)家說人不能兩次走入同一條河,說的也是同樣的道理。
這個錯誤從另一個方面提示我們,寫代碼應(yīng)該一個問題一個問題地解決,不要眉毛胡子一把抓,把幾個問題攪和在一塊。
好了。從內(nèi)容到形式,從算法到語法,代碼已經(jīng)是錯得一塌糊涂了,差不多要亮瞎我的雙眼了。沒有任何理由再繼續(xù)看下去了。就此打住。
原文鏈接:http://www.cnblogs.com/pmer/archive/2012/07/22/2604229.html
【編輯推薦】