戴莉萍，黃龍軍，胡國雄

淺析嵌入式實(shí)驗(yàn)中錯(cuò)誤的文檔化

戴莉萍，黃龍軍，胡國雄

（江西師范大學(xué) 軟件學(xué)院，南昌 330022）

通過分析嵌入式實(shí)驗(yàn)的特點(diǎn)，比較計(jì)算機(jī)語言實(shí)驗(yàn)與嵌入式實(shí)驗(yàn)中錯(cuò)誤的區(qū)別，提出了實(shí)驗(yàn)過程中的錯(cuò)誤文檔化。介紹了錯(cuò)誤文檔化的必要性、處理元素和通用格式，并結(jié)合具體實(shí)例加以說明。實(shí)踐結(jié)果證明：錯(cuò)誤文檔是對(duì)嵌入式實(shí)驗(yàn)教材的有力補(bǔ)充，可以成為實(shí)驗(yàn)指導(dǎo)教師的助手；而且學(xué)生對(duì)于錯(cuò)誤有了更深入的了解，有利于個(gè)體軟件工程師的能力培養(yǎng)。

嵌入式實(shí)驗(yàn)；錯(cuò)誤；文檔；能力

實(shí)驗(yàn)是計(jì)算機(jī)課程教學(xué)的重要組成部分。通過實(shí)驗(yàn)，學(xué)生可以將書本的理論知識(shí)轉(zhuǎn)化為實(shí)際應(yīng)用，進(jìn)而提高技術(shù)水平；教師可以了解學(xué)生掌握的程度，進(jìn)而適當(dāng)調(diào)整與改進(jìn)課堂教學(xué)內(nèi)容［1－2］。一般的計(jì)算機(jī)主干課程的實(shí)驗(yàn)內(nèi)容安排比較簡單直接，例如，數(shù)據(jù)結(jié)構(gòu)或C語言程序設(shè)計(jì)，整個(gè)過程中設(shè)備單一，一臺(tái)PC機(jī)即可；軟件工具單一，大多都是語言開發(fā)環(huán)境；實(shí)驗(yàn)教材較為豐富、步驟詳盡、通用性較強(qiáng)。相比較這些傳統(tǒng)課程的實(shí)驗(yàn)，嵌入式實(shí)驗(yàn)則體現(xiàn)較大不同。設(shè)備多樣且復(fù)雜，例如，PC機(jī)和配置了不同操作系統(tǒng)和性能的實(shí)驗(yàn)板箱；使用工具眾多，例如內(nèi)核定制工具、同步通信工具、FTP下載工具等；適用的實(shí)驗(yàn)教材較少，通用性不強(qiáng)，甚至教師自行編寫實(shí)驗(yàn)手冊(cè)。在實(shí)驗(yàn)的執(zhí)行過程中，實(shí)驗(yàn)的內(nèi)容、目的、步驟、及其結(jié)果往往會(huì)被一一記錄下來；而關(guān)于錯(cuò)誤的相應(yīng)記錄保存卻往往被忽視［3－4］?？紤]到嵌入式實(shí)驗(yàn)自身的特點(diǎn)，錯(cuò)誤的文檔化其實(shí)顯得尤為重要。本文著重討論了江西師范大學(xué)軟件學(xué)院錯(cuò)誤文檔化的必要性、處理要素以及格式。

1 錯(cuò)誤文檔化的必要性

普通計(jì)算機(jī)課程的實(shí)驗(yàn)錯(cuò)誤一般都出現(xiàn)在軟件環(huán)境上，硬件相關(guān)性較低。例如，大多數(shù)語言程序設(shè)計(jì)課程的實(shí)驗(yàn)過程中，大量的錯(cuò)誤集中在語法錯(cuò)誤或解題思路上，導(dǎo)致無法通過編譯或得到正確的預(yù)期結(jié)果。因此，錯(cuò)誤表現(xiàn)形式較為單一。例如，下面這段代碼是PC機(jī)上使用VC++連接SQL Server的代碼。

這段代碼量很少，常見的錯(cuò)誤主要在msa-do15.dll文件的引用、SQL Server啟動(dòng)服務(wù)和連接設(shè)置參數(shù)上，例如，msado15.dll文件沒有引用、引用的位置不正確、SQL Server相應(yīng)的服務(wù)沒有開啟、SQL Server身份驗(yàn)證和Windows身份驗(yàn)證使用混淆、連接字符串中各個(gè)參數(shù)書寫錯(cuò)誤等。參照實(shí)驗(yàn)教材的內(nèi)容比較就能發(fā)現(xiàn)不同，進(jìn)而修改。而且大多數(shù)錯(cuò)誤產(chǎn)生時(shí)，編譯器可以給予提示和錯(cuò)誤定位，調(diào)試比較容易。對(duì)于這些錯(cuò)誤再擴(kuò)展一步來說，很多技術(shù)網(wǎng)站也給出了比較正確的解決思路和方法，都是可以通用的。總的來說，這些實(shí)驗(yàn)過程中出現(xiàn)的錯(cuò)誤可以從教材、編譯環(huán)境、技術(shù)交流網(wǎng)站等多種途徑中找到解決方法。也正因?yàn)槿绱耍e(cuò)誤往往不會(huì)被保存下來，或者根本沒有必要保存下來。

嵌入式實(shí)驗(yàn)中的錯(cuò)誤不僅出現(xiàn)在PC機(jī)上，還會(huì)出現(xiàn)嵌入式實(shí)驗(yàn)設(shè)備上；不僅有軟件錯(cuò)誤，還有硬件物理錯(cuò)誤。實(shí)驗(yàn)設(shè)備的多樣性和環(huán)境配置的復(fù)雜性使得錯(cuò)誤的調(diào)試過程中面臨著對(duì)象不確定、位置不確定、方法不確定、結(jié)果不確定等［5－6］。例如，以下這段代碼是嵌入式數(shù)據(jù)庫SQLCE連接語句的主體部分，嵌入式實(shí)驗(yàn)板箱是MagicARM2410，開發(fā)工具仍是VC++。

與SQL Server數(shù)據(jù)庫連接代碼相比較，該段SQLCE數(shù)據(jù)庫連接代碼行數(shù)較多、變量較多、參量設(shè)置較多，其中的錯(cuò)誤體現(xiàn)了多樣性和復(fù)雜性。

（1）涉及的軟件工具眾多。編程環(huán)境的Visual Studio、與設(shè)備配套的SDK、同步作用的Active-Sync、下載內(nèi)核的Flash FTP、定制內(nèi)核的Platform-Builder、嵌入式數(shù)據(jù)庫應(yīng)用的SQL CE Tools等。

（2）配置步驟繁雜。為成功運(yùn)行，除了基本的編碼工作，需要進(jìn)行比較多的前期工作。例如，為支持SQL CE的應(yīng)用，需要重新定制內(nèi)核和生成對(duì)應(yīng)的SDK，整個(gè)過程涉及20多個(gè)組件的選擇；PC機(jī)上安裝SQL CE Tools；設(shè)置ActiveSync的同步參數(shù)、IP地址設(shè)定等。配置不當(dāng)則會(huì)造成程序運(yùn)行中斷，而且難以進(jìn)行錯(cuò)誤定位。

（3）軟件錯(cuò)誤出現(xiàn)次數(shù)較多。頭文件的引用、變量的寫法、參量定義的值、方法的調(diào)用等都容易潛在錯(cuò)誤。例如，需要兩個(gè)頭文件，很可能就漏了一個(gè)；環(huán)境初始化語句遺漏；數(shù)據(jù)文件未創(chuàng)建就直接進(jìn)行訪問；數(shù)據(jù)庫創(chuàng)建語句和連接語句混淆；SDK中遺漏“ATL for Windows CE application”選項(xiàng)使得編譯無法通過等。錯(cuò)誤容易產(chǎn)生，而且涉及因素較多，從而使得調(diào)試尤為困難。

（4）相關(guān)的硬件錯(cuò)誤比較突出。在大多數(shù)情況下，錯(cuò)誤可以被追蹤到代碼一級(jí)。但是一個(gè)構(gòu)建好了的系統(tǒng)應(yīng)用必須運(yùn)行在一個(gè)存有其他系統(tǒng)應(yīng)用的環(huán)境中，當(dāng)出錯(cuò)時(shí)，必須考慮問題的所有因素，嵌入式程序的錯(cuò)誤尤其如此。例如，MagciARM2410上電池沒電會(huì)造成PC機(jī)與設(shè)備無法同步連接；斷路器的放置錯(cuò)誤會(huì)使得網(wǎng)線無用、或是無法通過PC機(jī)啟動(dòng)設(shè)備等。

當(dāng)出現(xiàn)各種錯(cuò)誤時(shí)，實(shí)驗(yàn)教材上往往并沒有這些問題的描述和相應(yīng)的解決方法；編譯器給出的錯(cuò)誤提示往往簡單，無法說明原因，更無法進(jìn)行錯(cuò)誤定位和解決了；網(wǎng)絡(luò)資源也是非常有限的。在這種情況下，錯(cuò)誤的記錄和保存就很有必要了。

2 錯(cuò)誤文檔化的要素

由于嵌入式實(shí)驗(yàn)中出現(xiàn)的錯(cuò)誤體現(xiàn)出多樣性、復(fù)雜性、難以解決等特點(diǎn)，因此除了一般的實(shí)驗(yàn)報(bào)告外，還必須具備錯(cuò)誤報(bào)告。一是教師可以積累實(shí)驗(yàn)素材、為以后的實(shí)驗(yàn)提供一定的幫助；二是提高學(xué)生調(diào)試技能、培養(yǎng)良好的開發(fā)方法。在錯(cuò)誤文檔化的過程中，需要考慮4個(gè)基本要素，即3W1H（Who，When，What and How。）

1）Who?！罢l來完成錯(cuò)誤文檔？”——做實(shí)驗(yàn)的人，即學(xué)生和教師。在實(shí)際實(shí)驗(yàn)中并沒有團(tuán)隊(duì)實(shí)驗(yàn)，全部是個(gè)人單獨(dú)完成，目的在于減少團(tuán)隊(duì)依賴性，增強(qiáng)個(gè)人交流。而且個(gè)人實(shí)驗(yàn)過程中出現(xiàn)的問題也不同，因此每個(gè)學(xué)生都必須進(jìn)行錯(cuò)誤記錄。對(duì)于教師來說，所有的實(shí)驗(yàn)必須提前完成，以便能夠?qū)W(xué)生進(jìn)行適當(dāng)指導(dǎo)，錯(cuò)誤必須文檔化。學(xué)生的錯(cuò)誤報(bào)告能對(duì)老師的錯(cuò)誤報(bào)告起到非常好的補(bǔ)充作用。

2）When?！笆裁磿r(shí)候記錄錯(cuò)誤？”——當(dāng)錯(cuò)誤出現(xiàn)時(shí)，就立刻隨手記錄下來；而后進(jìn)行調(diào)試過程中做必要的記錄；最后實(shí)驗(yàn)完成后進(jìn)行相應(yīng)的整理?；静襟E如圖1所示。

圖1 錯(cuò)誤文檔化的基本步驟

3）What?！坝涗浭裁磧?nèi)容？”——總的來說，就是錯(cuò)誤的表現(xiàn)形式、錯(cuò)誤發(fā)生的原因和解決方法、結(jié)果等內(nèi)容。在記錄過程中應(yīng)注意以下幾點(diǎn)。

（1）不是所有的錯(cuò)誤都需要記錄下來。如果能夠在實(shí)驗(yàn)教材中找到答案的，不需要記錄。例如，在SQLCE數(shù)據(jù)庫連接語句中，內(nèi)核定制時(shí)沒有選擇必要的組件會(huì)使得代碼運(yùn)行中斷，這時(shí)需要仔細(xì)閱讀內(nèi)核定制的基本步驟，重新定制即可。如果是代碼書寫錯(cuò)誤，不需要記錄。例如，變量名拼寫錯(cuò)誤、語句漏寫等，可以通過代碼復(fù)查技術(shù)調(diào)試。一般在配置步驟正確和代碼書寫基礎(chǔ)上出現(xiàn)的錯(cuò)誤，需要進(jìn)行記錄。例如，內(nèi)核定制編譯時(shí)需要關(guān)閉防火墻、上傳內(nèi)核時(shí)FlashFXP版本要合適、頭文件引用要保證順序性、全局變量定義位置要正確、內(nèi)核與SDK需要配套等。

（2）重復(fù)錯(cuò)誤不記錄。實(shí)驗(yàn)安排一般都具有一定的循序漸進(jìn)性，前面實(shí)驗(yàn)往往是后面實(shí)驗(yàn)的一個(gè)重要基礎(chǔ)。錯(cuò)誤文檔一般都有實(shí)驗(yàn)編號(hào)和名稱，如果在之前的程序?qū)嶒?yàn)中已經(jīng)出現(xiàn)的錯(cuò)誤，可以翻閱而不必記錄。例如，SQLCE連接實(shí)驗(yàn)中需要重新定制WinCE內(nèi)核和生成新的SDK，而內(nèi)核定制需要安裝的軟件、補(bǔ)丁、需要添加的組件選項(xiàng)、生成步驟在前面的實(shí)驗(yàn)中已經(jīng)具體描述過，相關(guān)的錯(cuò)誤都已經(jīng)記錄下來，因此在這里可以進(jìn)行錯(cuò)誤的簡單回顧，而不再做重復(fù)的記錄。

（3）未能解決的錯(cuò)誤需要記錄。實(shí)驗(yàn)過程中錯(cuò)誤出現(xiàn)的場合、時(shí)間、次數(shù)、表現(xiàn)形式都會(huì)令人頗為費(fèi)解，進(jìn)而影響排錯(cuò)的進(jìn)展和結(jié)果。沒有辦法解決的問題也把它記錄下來，供以后思考。

4）How?！霸鯓佑涗涘e(cuò)誤？”——錯(cuò)誤文檔化需要一定的格式和內(nèi)容。在下一節(jié)中詳細(xì)介紹。

3 錯(cuò)誤文檔化的格式規(guī)范

文檔本就是軟件開發(fā)實(shí)驗(yàn)過程中的自然組成部分，最主要的功能就是起到溝通作用。在這里學(xué)生之間以及師生之間都可以通過文檔了解相應(yīng)的實(shí)驗(yàn)過程和成果。文檔也是一種幫助整理思路的工具，實(shí)驗(yàn)內(nèi)容會(huì)在文檔化的過程中被加以細(xì)化和規(guī)范化，錯(cuò)誤文檔也是如此［7－8］。不同文檔、不同群體使用的文檔格式各有不同。這里采用的格式如表1所示。

表1 錯(cuò)誤記錄表

根據(jù)表1所顯示的內(nèi)容，日期是錯(cuò)誤出現(xiàn)的時(shí)間，可以具體到小時(shí)分鐘。進(jìn)行編號(hào)有助于將來的錯(cuò)誤分析和數(shù)據(jù)統(tǒng)計(jì)；在后續(xù)實(shí)驗(yàn)中，編號(hào)也有利于進(jìn)行錯(cuò)誤的回溯。在錯(cuò)誤描述中，盡量簡潔、完整、準(zhǔn)確，而且一圖勝千言。錯(cuò)誤修復(fù)步驟詳盡，特別是關(guān)鍵操作。修復(fù)時(shí)間是從開始意識(shí)到錯(cuò)誤的存在時(shí)算起，直到修復(fù)完成且檢查無誤的估計(jì)時(shí)間，最好以分鐘計(jì)算。圖2是一份SQLCE數(shù)據(jù)庫連接實(shí)驗(yàn)中的一個(gè)錯(cuò)誤描述。

圖2 錯(cuò)誤文檔實(shí)例

錯(cuò)誤文檔中各個(gè)數(shù)據(jù)項(xiàng)的書寫有利于提高實(shí)驗(yàn)技術(shù)水平、幫助改進(jìn)編程方法、減少其后實(shí)驗(yàn)中的錯(cuò)誤個(gè)數(shù)、節(jié)省未來實(shí)驗(yàn)時(shí)間、并培養(yǎng)良好的開發(fā)習(xí)慣。

4 結(jié)束語

本學(xué)院設(shè)有專門的嵌入式實(shí)驗(yàn)室，面向大三學(xué)生開放，實(shí)驗(yàn)教材由指導(dǎo)老師自己編寫。由于教材本身比較詳盡，因此一般的實(shí)驗(yàn)?zāi)康?、步驟、結(jié)果并不要求學(xué)生寫，但是期間發(fā)生的錯(cuò)誤及其解決過程則要求學(xué)生盡可能地詳細(xì)記錄下來。整個(gè)過程中增強(qiáng)了學(xué)生軟件工程的應(yīng)用意識(shí)，教學(xué)效果較好。而且每一個(gè)實(shí)驗(yàn)給學(xué)生帶來的信息量其實(shí)是比較多的，例如實(shí)驗(yàn)的規(guī)模數(shù)據(jù)、時(shí)間數(shù)據(jù)、錯(cuò)誤數(shù)據(jù)等，個(gè)人日常開發(fā)數(shù)據(jù)的記錄往往給下一步的團(tuán)隊(duì)開發(fā)的項(xiàng)目計(jì)劃提供了相應(yīng)的基礎(chǔ)和依據(jù)。實(shí)驗(yàn)的開展不僅僅是技術(shù)的單純提升，也可以個(gè)體軟件過程和團(tuán)隊(duì)軟件過程的小型實(shí)施，這也是我們下一步將要研究的內(nèi)容。

［1］權(quán)寧一，權(quán)曉林.嵌入式系統(tǒng)專業(yè)實(shí)驗(yàn)教學(xué)改革的探索與實(shí)踐［J］.實(shí)驗(yàn)技術(shù)與管理，2011，28（3）：146－148.

［2］吳磊.嵌入式教學(xué)與實(shí)驗(yàn)的研究［J］.實(shí)驗(yàn)室研究與探索，2011，30（11）：103－105.

［3］張明，沈勇，王阿娣.基于嵌入式系統(tǒng)課程體系的實(shí)驗(yàn)教學(xué)環(huán)節(jié)設(shè)置的研究［J］.實(shí)驗(yàn)技術(shù)與管理，2008，25（5）：147－149.

［4］羅鈞，廖紅華，付麗，黃勇.嵌入式實(shí)驗(yàn)教改與創(chuàng)新性人才培養(yǎng)的關(guān)系［J］.實(shí)驗(yàn)室研究與探索，2006，25（8）：958－960.

［5］李妍，崔永利.彈性學(xué)習(xí)制在嵌入式實(shí)驗(yàn)教學(xué)中的探索［J］.中國現(xiàn)代教育裝備，2010（19）：79－81.

［6］陳佳聞.嵌入式實(shí)驗(yàn)教學(xué)系統(tǒng)開發(fā)與應(yīng)用［J］.山東農(nóng)業(yè)大學(xué)學(xué)報(bào)：自然科學(xué)版，2011，42（3）：448－450.

［7］劉鈺，張燕，沈奇.計(jì)算機(jī)專業(yè)嵌入式系統(tǒng)方向人才培養(yǎng)探索［J］.實(shí)驗(yàn)技術(shù)與管理，2010，27（9）：164－167.

［8］李秀娟，張曉東，魯可，等.“嵌入式系統(tǒng)”開發(fā)實(shí)驗(yàn)室建設(shè)與實(shí)踐［J］.實(shí)驗(yàn)室研究與探索，2011，30（5）：156－158.

Research on Documentation about Errors for Embedded Experiments

DAILiping，HUANG Longjun，HU Guoxiong
（Software School of Jiangxi Normal University，Nanchang 330022，China）

By analyzing the features of embedded experiments，and pointing out the differences between the experiments for the common computer language and those for the special embedded experiments，we put forward the documentation abouterrors during the experimental process.With the actual examples，the necessity，factors and general formatof errors documentation are illustrated.Practical results have showed thaterrors documentation is very helpful to the textbooks of embedded experiments and the teachers'guidance. In addition，this hasmade the students paymore attention to the developmenterrors and capability building of a personal software engineer.

embedded experiments；errors；documentation；ability

TP399；G642.1

A

10.3969/j.issn.1672－4550.2014.05.017

2013－11－22

戴莉萍（1979－），女，講師，研究方向：軟件工程、數(shù)據(jù)庫技術(shù)。