1、“數據結構與算法”程序設計風格和注釋要求1誠實代碼保證在“數據結構與算法”課程今后的實習報告中，同學們提交的每個程序都應該遵循Honor Code（誠實代碼保證）的要求。請大家特別注意一定要在每個程序首部的注釋中加上以下保證： / 我真誠地保證： / 我自己獨立地完成了整個程序從分析、設計到編碼的所有工作。/ 如果在上述過程中，我遇到了什么困難而求教于人，那么，我將在程序實習報告中/ 詳細地列舉我所遇到的問題，以及別人給我的提示。/ 在此，我感謝 XXX, , XXX對我的啟發和幫助。下面的報告中，我還會具體地提到/ 他們在各個方法對我的幫助。 / 我的程序里中凡是引用到其他程序或文檔之處，/

2、 例如教材、課堂筆記、網上的源代碼以及其他參考書上的代碼段,/ 我都已經在程序的注釋里很清楚地注明了引用的出處。/ 我從未抄襲過別人的程序，也沒有盜用別人的程序，/ 不管是修改式的抄襲還是原封不動的抄襲。 / 我編寫這個程序，從來沒有想過要去破壞或妨礙其他計算機系統的正常運轉。 / 如果沒有在提交程序時加上這段保證，將被認為違背了Honor Code規則。本次上機題記零分或根據抄襲情況倒扣分。2.內部文檔要求 .每個源文件和頭文件都必須在文件首部的注釋中注明設計者姓名，項目名（即我們的上機題目名），創建日期和最近一次修改日期。包含main()函數的源文件必須在首部注釋后另加一段注釋,簡要描述一

3、下程序的目的和用到的主要數據結構。文件注釋格式如下：文件名稱：項目名稱：創建者：創建時間：最后修改時間：功能： 文件中的函數名稱和簡單功能描述：文件中定義的全局變量和簡單功能描述：文件中用到的他處定義的全局變量及其出處：與其他文件的依賴關系： .每個類必須包含首部注釋塊，適度地描述這個類的目的。類的首部注釋應該緊挨著放在類的聲明（一般在頭文件里）前面。類的注釋格式如下：類名稱：定義該類的目的：類屬性：類中函數及功能：與其他類的關系（調用/被調用哪類對象中的什么函數）： .每個函數必須有首部注釋塊，描述該函數的簡要功能，每個參數的邏輯含義(包括它是輸入還是輸出或者輸入/輸出)，函數調用之前的預備

4、條件，返回后的處理，返回值（如果有的話），該函數要調用到的函數列表（如果有）。這些函數頭注釋可能和函數原型或函數實現放在一起。應該注意到：這項要求不僅適合于單獨的函數，同樣適合于類的成員函數。函數的注釋格式如下：函數名稱：函數功能描述：函數調用之前的預備條件：返回后的處理：返回值（如果有的話）：函數的輸入參數：函數的輸出參數：函數的抽象算法（偽碼）： 函數與其他對象中函數的調用和被調用關系： .所有局部變量或常量的聲明后應該簡要說明一下他們的含義和用途。 .主要的控制結構，例如循環或分支結構，應該在前面注明以下代碼將要完成什么功能。 .采用清晰一致的縮進格式和其他格式化風格（例如括號的定位）來

5、提高代碼可讀性。3. 過程代碼要求 .標識符名稱（常量、變量、函數、類等等）應該具有描述性，便于理解。 .要用到某個常數時，最好設置一個常量來代替這個數字。 .采用枚舉類型來表示內部標簽和狀態的分類。 .盡量不要用全局或文件范圍變量。但是允許采用全局范圍內的類型定義（包括類定義）。 .采用適當的途徑傳遞函數參數。當被調用函數需要修改實參的值時一般只采用引用傳參或指針傳參。當傳遞結構較大而不被修改的參數時，采用常量引用傳參或者常量指針傳參。當被調用函數只需改變形參（調用內部）而保持實參不變的時候采用傳值傳參。 .采用string對象來存儲字符串數據（除了單個字符），而不用字符數組來表示。 .任何

6、時候都采用新式的c+。例如：采用代替。不要混合使用舊式c+和新式 c+。 .采用I/O流代替C風格的I/O。4. 面向對象的代碼要求 .盡量采用類。不要用成員函數來實現結構類型。 .一般來講，建議采用類模板來表示容器型結構，如列表、樹等，以提高可重用性。 .設計類時，每個類都具有比較好的完整性（即該類的數據成員和函數成員具有比較好的內聚性和一致性，不要把不相干的東西湊合在一起，也不要把相關的東西生生拆散）。 .類的所有數據成員都應該是私有的。.很多情況下，類的某些成員函數應該也是私有的。視情況而定。 .所有訪問型指針都盡可能加const修飾（以區別于引用型指針）。 .如果一個類數據成員是一個指向動態分配內存的指針，要求寫出析構函數來釋放內存；并寫出一個用于復制對象的構造函數（copy constructor），而且寫出賦值操作的重載運算（assignment operator overload）。 .僅當有必要時才采用繼承機制。 .盡量少使用MFC庫中的類，可以適當地使用STL的類（但是，如果同學們對于最基本的數據結構，例如棧、隊列等還不熟悉的情況下，還是盡量自己來編寫基本類）。如果要編圖形界