好的C編程習(xí)慣(3)
1. 注釋規(guī)范 為了提高代碼的可讀性和可維護性,我們應(yīng)該在文件開頭添加注釋,包括項目名、作者、描述、版本、修改、參考文獻等信息。此外,要對頭文件進行定義,以避免重復(fù)包含。 2. 其他注釋 在函數(shù)
1. 注釋規(guī)范
為了提高代碼的可讀性和可維護性,我們應(yīng)該在文件開頭添加注釋,包括項目名、作者、描述、版本、修改、參考文獻等信息。此外,要對頭文件進行定義,以避免重復(fù)包含。
2. 其他注釋
在函數(shù)內(nèi)部,不需要對每一行語句進行注釋。但是,在每個功能模塊的主要部分之前,應(yīng)該添加塊注釋,對該模塊的功能進行說明。在循環(huán)、流程的分支等地方,盡可能添加注釋,增加代碼的可讀性。
3. 程序健壯性
為了保證程序的穩(wěn)定性和可靠性,我們需要注意以下幾點:
- 函數(shù)的返回位置要保持單一性,即一個函數(shù)只有一個返回位置。
- 盡量少使用goto語句,并且只能向后轉(zhuǎn)移。
- 對于消耗系統(tǒng)資源的變量,必須賦初值,并在用完后立即釋放并重新賦值。
- 對于復(fù)雜的條件判斷,應(yīng)該使用括號來增加程序的可讀性。
4. 可移植性
為了讓代碼能夠跨平臺運行,我們應(yīng)該考慮不同平臺的支持。盡可能使用C代碼而非C 代碼來編寫算法函數(shù)。對于不同的硬件和軟件,需要做不同的處理。
5. 錯誤處理
在編程中,我們應(yīng)該考慮各種執(zhí)行情況,并盡可能處理所有的流程情況。對于與屏幕顯示無關(guān)的函數(shù),通過返回值報告錯誤;對于與屏幕顯示相關(guān)的函數(shù),要向用戶發(fā)出警告并進行錯誤處理。
6. 盡早發(fā)現(xiàn)錯誤
為了盡早發(fā)現(xiàn)程序中的錯誤,我們應(yīng)該重視編譯器中的警告信息,并認(rèn)真檢查每一個警告信息,消除潛在的錯誤危險。利用斷言來檢查錯誤假設(shè)或防止參數(shù)的非法值也是一種好的辦法。
7. 模塊化規(guī)范
為了提高軟件的重用性和可維護性,應(yīng)該加強軟件的模塊化工作。每個函數(shù)應(yīng)該精煉而小巧,代碼行數(shù)不應(yīng)超過150行。如果某個功能被重復(fù)實現(xiàn)三次以上,應(yīng)考慮將其模塊化為通用函數(shù)。開發(fā)人員應(yīng)盡可能利用他人的現(xiàn)成模塊,減少重復(fù)開發(fā)。在進行函數(shù)模塊化時,要考慮函數(shù)之間的層次關(guān)系,并確保相同功能的不同函數(shù)沒有重復(fù)代碼,以便于代碼維護。