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