概述
隨著計算機技術的發展,軟體的規模增大了,軟體的複雜性也增強了。為了提高程式的可閱讀性,要建立良好的編程風格。
風格就是一種好的規範,當然我們所說的程式設計風格肯定是一種好的程式設計規範,包括良好的代碼設計,函式模組,接口功能以及可擴展性等,更重要的就是程式設計過程中代碼的風格,包括縮進,注釋,變數及函式的命名,泛型和容易理解。
指導原則
源程式文檔化
(1)標識符應按意取名。
(2)程式應加注釋。注釋是程式設計師與日後讀者之間通信的重要工具,用自然語言或偽碼描述。它說明了程式的功能,特別在維護階段,對理解程式提供了明確指導。注釋分序言性注釋和功能性注釋。序言性注釋應置於每個模組的起始部分,主要內容有:
①說明每個模組的用途、功能。
②說明模組的接口:調用形式、參數描述及從屬模組的清單。
③數據描述:重要數據的名稱、用途、限制、約束及其他信息。
④開發歷史:設計者、審閱者姓名及日期,修改說明及日期。
功能性注釋嵌入在源程式內部,說明程式段或語句的功能以及數據的狀態。注意以下幾點:
①注釋用來說明程式段,而不是每一行程式都要加注釋。
②使用空行或縮格或括弧,以便很容易區分注釋和程式。
③修改程式也應修改注釋。
數據說明原則
為了使數據定義更易於理解和維護,有以下指導原則:
(1)數據說明順序應規範,使數據的屬性更易於查找,從而有利於測試、糾錯與維護。例如按以下順序:常量壽命、類型說明、全程量說明、局部量說明。
(2)一個語句說明多個變數時,各變數名按字典序排列。
(3)對於複雜的數據結構,要加注釋,說明在程式實現時的特點。
語句構造原則
語句構造的原則是:簡單直接,不能為了追求效率而使代碼複雜化。為了便於閱讀和理解,不要一行多個語句。不同層次的語句採用縮進形式,使程式的邏輯結構和功能特徵更加清晰。要避免複雜的判定條件,避免多重的循環嵌套。表達式中使用括弧以提高運算次序的清晰度等等。
輸入輸出原則
輸入和輸出在編寫輸入和輸出程式時考慮以下原則:
(1)輸入操作步驟和輸入格式儘量簡單。
(2)應檢查輸入數據的合法性、有效性,報告必要的輸入狀態信息及錯誤信息。
(3)輸入一批數據時,使用數據或檔案結束標誌,而不要用計數來控制。
(4)互動式輸入時,提供可用的選擇和邊界值。
(5)當程式設計語言有嚴格的格式要求時,應保持輸入格式的一致性。
(6)輸出數據表格化、圖形化。
輸入、輸出風格還受其他因素的影響,如輸入、輸出設備,用戶經驗及通信環境等。
追求效率原則
指處理機時間和存儲空間的使用,對效率的追求明確以下幾點:
(1)效率是一個性能要求,目標在需求分析給出。
(2)追求效率建立在不損害程式可讀性或可靠性基礎上,要先使程式正確,再提高程式效率,先使程式清晰,再提高程式效率。
(3)提高程式效率的根本途徑在於選擇良好的設計方法、良好的數據結構算法,而不是靠編程時對程式語句做調整。