注釋向來(lái)也是爭(zhēng)議之一，不加注釋和過(guò)多的注釋我都是反對(duì)的。不加注釋的代碼顯然是很糟糕的，但過(guò)多的注釋也會(huì)妨礙程序的可讀性，由于注釋可能存在的歧義，有可能會(huì)誤解程序真實(shí)意圖，此外，過(guò)多的注釋會(huì)增加程序員不必要的時(shí)間。如果你的編碼樣式整潔、命名又很清晰，那么，你的代碼可讀性不會(huì)差到哪去，而注釋的本意就是為了便于理解程序。

這里建議使用良好的編碼樣式和清晰的命名來(lái)減少注釋?zhuān)瑢?duì)模塊、函數(shù)、變量、數(shù)據(jù)結(jié)構(gòu)、算法和關(guān)鍵代碼做注釋?zhuān)瑧?yīng)重視注釋的質(zhì)量而不是數(shù)量。如果你需要一大段注釋才能說(shuō)清楚程序做什么，那么你應(yīng)該注意了：是否是因?yàn)槌绦蜃兞棵粔蚯逦?，或者代碼邏輯過(guò)于混亂，這個(gè)時(shí)候你應(yīng)該考慮的可能就不是注釋?zhuān)侨绾尉?jiǎn)這個(gè)程序了。

2. 數(shù)據(jù)結(jié)構(gòu)

數(shù)據(jù)結(jié)構(gòu)是程序設(shè)計(jì)的基礎(chǔ)。在設(shè)計(jì)程序之前，應(yīng)該先考慮好所需要的數(shù)據(jù)結(jié)構(gòu)。

前微軟首席架構(gòu)師Charles Simonyi：編程的第一步是想象。就是要在腦海中對(duì)來(lái)龍去脈有極為清晰的把握。在這個(gè)初始階段，我會(huì)使用紙和鉛筆。我只是信手涂鴉，并不寫(xiě)代碼。我也許會(huì)畫(huà)些方框或箭頭，但基本上只是涂鴉，因?yàn)檎嬲南敕ㄔ谖夷X海里。我喜歡想象那些有待維護(hù)的結(jié)構(gòu)，那些結(jié)構(gòu)代表著我想編碼的真實(shí)世界。一旦這個(gè)結(jié)構(gòu)考慮得相當(dāng)嚴(yán)謹(jǐn)和明確，我便開(kāi)始寫(xiě)代碼。我會(huì)坐到終端前，或者換在以前的話(huà)，就會(huì)拿張白紙，開(kāi)始寫(xiě)代碼。這相當(dāng)容易。我只要把頭腦中的想法變換成代碼寫(xiě)下來(lái)，我知道結(jié)果應(yīng)該是什么樣的。大部分代碼會(huì)水到渠成，不過(guò)我維護(hù)的那些數(shù)據(jù)結(jié)構(gòu)才是關(guān)鍵。我會(huì)先想好數(shù)據(jù)結(jié)構(gòu)，并在整個(gè)編碼過(guò)程中將它們牢記于心。

開(kāi)發(fā)過(guò)以太網(wǎng)和操作系統(tǒng)SDS 940的Butler Lampson：（程序員）最重要的素質(zhì)是能夠把問(wèn)題的解決方案組織成容易操控的結(jié)構(gòu)。

開(kāi)發(fā)CP/M操作系統(tǒng)的Gary.A：如果不能確認(rèn)數(shù)據(jù)結(jié)構(gòu)是正確的，我是決不會(huì)開(kāi)始編碼的。我會(huì)先畫(huà)數(shù)據(jù)結(jié)構(gòu)，然后花很長(zhǎng)時(shí)間思考數(shù)據(jù)結(jié)構(gòu)。在確定數(shù)據(jù)結(jié)構(gòu)之后我就開(kāi)始寫(xiě)一些小段的代碼，并不斷地改善和監(jiān)測(cè)。在編碼過(guò)程中進(jìn)行測(cè)試可以確保所做的修改是局部的，并且如果有什么問(wèn)題的話(huà)，能夠馬上發(fā)現(xiàn)。

微軟創(chuàng)始人比爾**·**蓋茨：編寫(xiě)程序最重要的部分是設(shè)計(jì)數(shù)據(jù)結(jié)構(gòu)。接下來(lái)重要的部分是分解各種代碼塊。

編寫(xiě)世界上第一個(gè)電子表格軟件的Dan Bricklin：在我看來(lái)，寫(xiě)程序最重要的部分是設(shè)計(jì)數(shù)據(jù)結(jié)構(gòu)，此外，你還必須知道人機(jī)界面會(huì)是什么樣的。

我們舉個(gè)例子來(lái)說(shuō)明。在介紹防御性編程的時(shí)候，提到公司使用的LCD顯示屏抗干擾能力一般，為了提高LCD的穩(wěn)定性，需要定期讀出LCD內(nèi)部的關(guān)鍵寄存器值，然后跟存在Flash中的初始值相比較。需要讀出的LCD寄存器有十多個(gè)，從每個(gè)寄存器讀出的值也不盡相同，從1個(gè)到8個(gè)字節(jié)都有可能。如果不考慮數(shù)據(jù)結(jié)構(gòu)，編寫(xiě)出的程序?qū)?huì)很冗長(zhǎng)。

void lcd_redu(void) ? { ? 
? 讀第一個(gè)寄存器值; ? ?
 if(第一個(gè)寄存器值==Flash存儲(chǔ)值) ?
 ? { ? ? ? ? 讀第二個(gè)寄存器值;
 ? ? ? ? if(第二個(gè)寄存器值==Flash存儲(chǔ)值) 
? ? ? ? { ? ? ? ? ? ? ...  ? ? ?
 ? ? ? 讀第十個(gè)寄存器值; ? ? ? ? ? 
? if(第十個(gè)寄存器值==Flash存儲(chǔ)值) ? ?
 ? ? ? ? { ? ? ? ? ? ? ?
 ? 返回; ? ? ? ? ?
 ? } ? ? ?
 ? ? ? else ? ? ? ? ?
 ? ? { ? ? ? ? ? ? ?
 ? 重新初始化LCD; ? ? ? 
? ? ? } ? ? ? ? } ? ? ?
 ? else ? ? ? ? ? { ? 
? ? ? ? ? 重新初始化LCD; ? ? ?
 ? } ? ? } ? ? else ? ?
 ? { ? 
? ? ? 重新初始化LCD; ?
 ? } }

我們分析這個(gè)過(guò)程，發(fā)現(xiàn)能提取出很多相同的元素，比如每次讀LCD寄存器都需要該寄存器的命令號(hào)，都會(huì)經(jīng)過(guò)讀寄存器、判斷值是否相同、處理異常情況這一過(guò)程。所以我們可以提取一些相同的元素，組織成數(shù)據(jù)結(jié)構(gòu)，用統(tǒng)一的方法去處理這些數(shù)據(jù)，將數(shù)據(jù)與處理過(guò)程分開(kāi)來(lái)。

我們可以先提取相同的元素，將之組織成數(shù)據(jù)結(jié)構(gòu)：

?

?

 typedef struct { ? ? ? uint8_t ?lcd_command; ? ? ? ? ? //LCD寄存器 ? ? ? uint8_t ?lcd_get_value[8]; ? ? ?//初始化時(shí)寫(xiě)入寄存器的值 ? ? ? uint8_t ?lcd_value_num; ? ? ? ? //初始化時(shí)寫(xiě)入寄存器值的數(shù)目 ? }lcd_redu_list_struct;

?

?

這里lcd_command表示的是LCD寄存器命令號(hào)；lcd_get_value是一個(gè)數(shù)組，表示寄存器要初始化的值，這是因?yàn)閷?duì)于一個(gè)LCD寄存器，可能要初始化多個(gè)字節(jié)，這是硬件特性決定的；lcd_value_num是指一個(gè)寄存器要多少個(gè)字節(jié)的初值，這是因?yàn)槊恳粋€(gè)寄存器的初值數(shù)目是不同的，我們用同一個(gè)方法處理數(shù)據(jù)時(shí)，是需要這個(gè)信息的。

就本例而言，我們將要處理的數(shù)據(jù)都是事先固定的，所以定義好數(shù)據(jù)結(jié)構(gòu)后，我們可以將這些數(shù)據(jù)組織成表格：

　　/*LCD部分寄存器設(shè)置值列表*/

　　lcd_redu_list_struct const lcd_redu_list_str［］= {

　　{SSD1963_Get_Address_Mode，{0x20}

　　，1}， /*1*/

　　{SSD1963_Get_Pll_Mn

　　，{0x3b，0x02，0x04}

　　，3}， /*2*/

　　{SSD1963_Get_Pll_Status ，{0x04}

　　，1}， /*3*

　　{SSD1963_Get_Lcd_Mode

　　，{0x24，0x20，0x01，0xdf，0x01，0x0f，0x00}

　　，7}， /*4*/

　　{SSD1963_Get_Hori_Period ，{0x02，0x0c，0x00，0x2a，0x07，0x00，0x00，0x00}，8}， /*5*/

　　{SSD1963_Get_Vert_Period ，{0x01，0x1d，0x00，0x0b，0x09，0x00，0x00}

　　，7}， /*6*/

　　{SSD1963_Get_Power_Mode ，{0x1c}

　　，1}， /*7*/

　　{SSD1963_Get_Display_Mode，{0x03}

　　，1}， /*8*/

　　{SSD1963_Get_Gpio_Conf ，{0x0F，0x01}

　　，2}， /*9*/

　　{SSD1963_Get_Lshift_Freq ，{0x00，0xb8}

　　，2}， /*10* };

至此，我們就可以用一個(gè)處理過(guò)程來(lái)完成數(shù)十個(gè)LCD寄存器的讀取、判斷和異常處理了：

/** * lcd 顯示冗余 * 每隔一段時(shí)間調(diào)用該程序一次 */??

 void lcd_redu(void) ?{ ? 
? uint8_t ?tmp[8]; ?
 ? uint32_t i,j; ? ?
 uint32_t lcd_init_flag;  
? ? lcd_init_flag =0; ?
 ? for(i=0;i

	通過(guò)合理的數(shù)據(jù)結(jié)構(gòu)，我們可以將數(shù)據(jù)和處理過(guò)程分開(kāi)，LCD冗余判斷過(guò)程可以用很簡(jiǎn)潔的代碼來(lái)實(shí)現(xiàn)。更重要的是，將數(shù)據(jù)和處理過(guò)程分開(kāi)更有利于代碼的維護(hù)。比如，通過(guò)實(shí)驗(yàn)發(fā)現(xiàn)，我們還需要增加一個(gè)LCD寄存器的值進(jìn)行判斷，這時(shí)候只需要將新增加的寄存器信息按照數(shù)據(jù)結(jié)構(gòu)格式，放到LCD寄存器設(shè)置值列表中的任意位置即可，不用增加任何處理代碼即可實(shí)現(xiàn)！這僅僅是數(shù)據(jù)結(jié)構(gòu)的優(yōu)勢(shì)之一，使用數(shù)據(jù)結(jié)構(gòu)還能簡(jiǎn)化編程，使復(fù)雜過(guò)程變的簡(jiǎn)單，這個(gè)只有實(shí)際編程后才會(huì)有更深的理解。

	編輯：黃飛

	?