SSIP4-304编码规范-Csharp(说明)_B_20071228.docVIP

編碼規範 （C#） 文件編碼： SSIP4-304 版 次： A 機密等級： □極機密 □機密 ▓密 □普通 製作日期： 2007-8-10 製作單位： EPG 總 頁 次： 17 修 訂 履 歷 版次 變更單編號 發行日期 作者 修 訂 內 容 備 注 A 2007/08/10 季向華 初版發行 B 2007/12/28 韋茂軍 矯正12個Action問題追蹤 目 錄 1. 目 的 3 2. 適用範圍 3 3. 注釋規範 3 4. 命名規範 6 5. 編碼規則 9 6. 編碼準則 12 7. 代碼包規範 14 8. 代碼的控制 15 9. 輸入控制校驗規則 16 附件1：資料類型縮寫表 16 附件2：伺服器控制項名縮寫表 17  目 的 為了統一開發組軟體發展的設計過程中關於代碼編寫時的編寫規範和具體開發工作時的編碼規範，保證代碼的一致性，便於交流和維護，特制定此規範。 適用範圍 本規範適用于開發組全體人員，作用于軟體專案開發的代碼編寫階段和後期維護階段。 注釋規範 概述: a)???注釋要求用中﹑英文及中﹑英文的標點符號。 b)???注釋中，應標明物件的完整的名稱及其用途，但應避免對代碼過於詳細的描述。 如﹕ /* * FileName: ClassLibrary * CopyWriter (c) Foxconn-SIDC-DCSO 編碼車間 * Writer: TangCheng * Create Date: 2007-7-4 * Rewriter: * Rewirter Date: * Impact: 常用處理圖片的類及方法。 * Main Content: ChangePicture,…. * */ namespace ClassLibrary { using System; using System.Drawing; /// summary /// 用于改變圖片的大小常用類 /// /summary public class ChangePicture { …… } } c)???每行注釋的最大長度為100個字元。 d)???將注釋與注釋分隔符號用一個空格分開。 e)???不允許給注釋加外框。 f)???編碼的同時書寫注釋。 g)??重要變量必須有注釋。 h)??變量注釋和變量在同一行，所有注釋必須對齊，與變量分開至少兩個“Tab”鍵。 如：int m_iLevel; // m_iLevel tree level int m_iCount;???? // m_iCount count of tree items ??? string m_strSql;??????????? //SQL i)?? 典型演算法必須有注釋。 如﹕遞歸算法﹑冒泡算法… /// summary /// 根據子文件夾的路徑得到父文件夾的路徑 /// /summary /// param name=p_strFilePath子文件夾路徑/param /// returns父文件夾路徑/returns public string GetFolderPath(string p_strFolderPath) { ….. DirectoryInfo dirFolderPath = new DirectoryInfo(p_strFolderPath); string strFolderPath = dirFolderPath.Parent; GetFolderPath(strFolderPath); //得到父文件夾的路徑 …… } j)???在迴圈和邏輯分支地方的上行必須就近書寫注釋。 k)???程式段或語句的注釋在程式段或語句的上一行 l)????在代碼交付之前，必須刪掉臨時的或無關的注釋。 m)???為便於閱讀代碼，建議每行