规范你的代码编写风格
筆者寄語:一份編寫規范的代碼會讓人賞心悅目,養成良好的代碼編寫習慣是每一個程序員應該具備的基本素養!
1、基本規則
【規則1-1】標識符應當直觀且可以拼讀,可望文知意,不必進行“解碼”。
例如:標識符最好采用英文單詞或其組合,便于記憶和閱讀。切忌使用漢語拼音來命名。程序中的英文單詞一般不會太復雜,用詞應當準確。例如不要把CurrentValue寫成NowValue。
【規則1-2】標識符的長度應當符合“min-length && max-information”原則。
【規則1-3】命名規則盡量與所采用的操作系統或開發工具的風格保持一致。
例如Windows應用程序的標識符通常采用“大小寫”混排的方式,如AddChild。而Unix應用程序的標識符通常采用“小寫加下劃線”的方式,如add_child。別把這兩類風格混在一起用。
【規則1-4】程序中不要出現僅靠大小寫區分的相似的標識符。
【規則1-6】變量的名字應當使用“名詞”或者“形容詞+名詞”。
【規則1-7】全局函數的名字應當使用“動詞”或者“動詞+名詞”(動賓詞組)。類的成員
函數應當只使用“動詞”,被省略掉的名詞就是對象本身。
【規則1-8】用正確的反義詞組命名具有互斥意義的變量或相反動作的函數等。
【建議1-1】盡量避免名字中出現數字編號,如Value1,Value2等,除非邏輯上的確需要編號。這是為了防止程序員偷懶,不肯為命名動腦筋而導致產生無意義的名字(因為用數字編號最省事)。
2、簡單的Windows應用程序命名規則
【規則2-1】類名和函數名用大寫字母開頭的單詞組合而成
【規則2-2】變量和參數用小寫字母開頭的單詞組合而成。
問:對象和結構體成員命名規則?
【規則2-3】常量全用大寫的字母,用下劃線分割單詞。
【規則2-4】靜態變量加前綴s_(表示static)。
【規則2-5】如果不得已需要全局變量,則使全局變量加前綴g_(表示global)。
【規則2-6】類的數據成員加前綴m_(表示member),這樣可以避免數據成員與成員函數的參數同名。
【規則2-7】為了防止某一軟件庫中的一些標識符和其它軟件庫中的沖突,可以為各種標識符加上能反映軟件性質的前綴。例如三維圖形標準OpenGL的所有庫函數均以gl開頭,所有常量(或宏定義)均以GL開頭。
項目經驗:
1、所有vector類容器命名在最后都加上Gather,set類容器命名最后面都加上Set
2、結構體變量以t開頭
3、指針以p開頭
4、臨時變量以temp開頭
注:本篇博文為自己學習過程的心得筆記,如有內容雷同,還請見諒,謝謝!
總結
以上是生活随笔為你收集整理的规范你的代码编写风格的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 【笔记】ARM架构和ARM芯片(一)
- 下一篇: quectel(短消息服务命令)9