軟體專案程式設計規範

2021-06-20 18:29:35 字數 1128 閱讀 6108

1. 每個檔案級模組必須編寫乙個說明,模組說明要求以注釋的形式出現在模組的首部,要寫清楚該模組的功能,並寫明編寫人及編寫時間(為了以後系統整合時交流方便一些);

2. 對於每乙個函式都應給出函式說明,描述其函式功能、引數說明以及返回值說明,如果是修改別人的檔案,應寫明編寫人及修改時間;

3. 標頭檔案書寫規範

標頭檔案應該按固定的順序編寫,首先使用 #include包含語句編寫本標頭檔案中需要包含的其他標頭檔案,其次宣告函式原型,接著定義用到的資料常量。定義資料常量使用#define語句,並且使用#ifndef/#define/#endif巨集來防止重複定義,方便各模組之間相互呼叫。

4. 變數命名

變數的命名應該能夠反映變數的資料型別和含義,採用英文命名,最好能做到見名知意。命名必須具有一定的實際意義。

常量的命名:全部用大寫。

變數的命名:變數名加字首,字首反映變數的資料型別,用小寫;反映變數意義的第乙個字母大寫,其他小寫。

函式的命名:函式名首字母大寫,若包含有兩個單詞的,則每個單詞首字母大寫。函式原型說明包括引用外部函式及內部函式,外部引用必須在右側註明函式**(模組名及檔名)。

5. 注釋

可以採用/* */和//進行注釋;

注釋寫在**的上方或者右方,千萬不要寫在下方;

對重要變數說明其作用;

對每一段函式**加注釋說明功能;

對重要的語句加注釋說明其功能;

對重要的函式呼叫的引數加實際引數說明;

在自己認為必要的地方加上注釋。

6. 書寫規範

縮排:書寫**時要注意括號對齊,固定縮排。根據語句間的層次關係採用縮排格式書寫程式,每進一層,往後縮排一層。縮排以 tab 為單位,乙個 tab 為4個空格大小。

乙個各佔一行,if/for/while/do等語句各佔一行,執行語句不得緊跟其後。

一行只實現乙個功能,不要在一行寫多條語句。

不管有沒有無效分支,switch函式一定要default這個分支。一來讓閱讀者知道程式設計師並沒有遺忘default,並且防止程式執行過程中出現的意外(健壯性)。

指標說明符與前面的型別之間加空格,與變數名之間不要加空格。

7、程式設計時,對於一些固定的常量以及常需要在除錯時修改的引數最好用 #define定義,但要注意巨集定義只是簡單的替換,因此有些括號不可少。

軟體專案結構規範

一 為什麼要結構規範化 結構規範化當然為了整齊劃一,方便他人閱讀和自己閱讀。二 規範化的目錄組織方式 一般情況下都是這種方式,上圖摘自roygood 部落格 1.foo是我們的專案名稱 2.bin 下面存放專案的可執行檔案和指令碼 3.db database的縮寫 用來儲存一些資料 4.docs 一...

軟體專案開發目錄規範

所謂的軟體專案開發目錄規範,就是根據不同檔案的特點特徵,分門別類,也就是根據功能特點劃分為不同的分組,和我們日常生活中的文字目錄類似。在日常生活中,我們經常會遇到東西丟三落四,並且不同的東西都放到同乙個容器內在尋找某乙個物品的時候就會很麻煩,其實在軟體開發中也是一樣,如果不對不同功能的檔案進行分類,...

軟體程式設計規範總則2

程式設計規範總則2 識別符號命名 1 識別符號的命名要清晰 明了,有明確含義,同時使用完整的單詞或大家基本可以理解的編寫,避免使人產生誤解。2 命名中若使用特殊約定或是縮寫,則要有注釋說明。3 自己特有的命名風格,要自始至終保持一致,不可來回變化。4 對於變數命名,禁止取單個字元 如i j k 是作...