1.2 壞代碼的特點
“幸福的人都是相似的,不幸的人各有各的不幸。”這句來自經典名著《安娜·卡列尼娜》的名言也可以延伸到編碼風格上——“良好的編碼風格遵循統一的規范,壞代碼各有不同的表現”。話雖如此,但根據筆者對大量代碼的觀察,壞代碼的“壞”大致體現在如下4個方面。
● 排版:所有與代碼的外觀相關的問題都可以歸于排版問題,比如不正確的對齊和縮進、省略該有的空格導致書寫擁擠等。在良好的編碼風格中,代碼的對齊、縮進、空格都應該遵循統一的標準。
● 命名:包括不正確的術語、不符合習慣的名稱、錯誤的時態、使用拼音、含有中文等特殊字符的文件名、命名風格不統一等。C語言本身雖然是獨立的,但在傳統上和英語息息相關,因此C代碼中的命名也應該盡量遵循正確的英語語法和用法習慣。另外,變量和函數等的命名風格雖然沒有“唯一正確”的標準,但在同一個程序或者項目中,命名風格應該統一。
● 過度使用:不分場合地過度使用某種語法特性。過度使用typedef
(類型定義)便是一個典型的例子。過度使用類型定義,會導致其他程序員在閱讀代碼時無法快速知悉一個類型到底是結構體、枚舉量、指針還是整數。
● 注釋:注釋是一種重要的代碼文檔工具,可以幫助程序員閱讀自己或他人的代碼。但是,不規范的注釋常常會影響我們對代碼的閱讀和理解,如注釋太多或太少、注釋風格不統一、注釋太花哨、注釋的內容和代碼脫節等。
推薦閱讀
- Vue 3移動Web開發與性能調優實戰
- SQL學習指南(第3版)
- 微服務與事件驅動架構
- Visual C++實例精通
- 編程珠璣(續)
- Hands-On GPU:Accelerated Computer Vision with OpenCV and CUDA
- MongoDB權威指南(第3版)
- 零基礎學Python網絡爬蟲案例實戰全流程詳解(高級進階篇)
- Learning JavaScript Data Structures and Algorithms
- SQL基礎教程(第2版)
- Java程序設計入門
- Python深度學習原理、算法與案例
- Python+Tableau數據可視化之美
- Regression Analysis with Python
- 深入淺出Go語言編程