軟體編程規範

軟體編程規範

在當前軟體行業迅猛的發展下,軟體逐漸走向大型化。在這種軟體走向大型化的形勢下,一個軟體需要眾多的人參與。比如一個作業系統的開發需要上千人的工作。這樣我們就不得不面臨著如何管理。 只要是一個有用的軟體就需要大量的工作,首先要進行軟體需求分析,然後要設計出軟體的框架,而實現軟體的代碼僅占很少一部分(約20%)。而你不要小看這代碼的實現,也是要很多人的參與的,一般軟體代碼就有上千行,更別說作業系統了,據說Linux就有千萬行的代碼。這就需要把一個軟體分成很多小的模組,分工完成。

編程規範概要

1、 程式結構清晰,簡單易懂,單個函式的程式行數不得超過100行。

2、 打算乾什麼,要簡單,直截了當,代碼精簡,避免垃圾程式。

3、 儘量使用標準庫函式和公共函式。

4、 不要隨意定義全局變數,儘量使用局部變數。

5、 使用括弧以避免二義性。

可讀性要求

1、可讀性第一,效率第二。

2、保持注釋與代碼完全一致。

3、每個源程式檔案,都有檔案頭說明,說明規格見規範。

4、每個函式,都有函式頭說明,說明規格見規範。

5、主要變數(結構、聯合、類或對象)定義或引用時,注釋能反映其含義。

6、常量定義(DEFINE)有相應說明。

7、處理過程的每個階段都有相關注釋說明。

8、在典型算法前都有注釋。

9、利用縮進來顯示程式的邏輯結構,縮進量一致並以Tab鍵為單位,定義Tab為 6個

位元組。

10、循環、分支層次不要超過五層。

11、注釋可以與語句在同一行,也可以在上行。

12、空行和空白字元也是一種特殊注釋。

13、一目了然的語句不加注釋。

14、注釋的作用範圍可以為:定義、引用、條件分支以及一段代碼。

15、注釋行數(不包括程式頭和函式頭說明部份)應占總行數的 1/5 到 1/3 。

相關詞條

熱門詞條

聯絡我們