姍姍來遲的代碼規範
學習建議
- 代碼規範是很重要的， 要重視!
- 個人感覺代碼規範是代碼的靈魂!(重視每一行代碼)
- 認爲代碼規範沒有什麼用處， 你就大錯特錯了
整潔的代碼
混亂的代碼會有什麼後果
- 進度延緩的程序會很嚴重， 即使你有一年的時間， 你也會像蝸牛一樣， 很緩慢
- 當程序出現了錯誤的時候, 更改代碼會眼花繚亂!
- 隨着混亂的增加， 生產力也持續下降。
結論: 當你寫出了好看的代碼， 不僅加快了開發速度， 而且會事半功倍
如何寫出整潔的代碼
- 越小越好
- 在意代碼、 在意細節
- 沒有重複的代碼
- 有責任心
- 代碼清晰、 簡潔
- 準守規則
比如 int a = 5; √
B = 6 × 爲什麼錯， 因爲沒有定義變量b, 應該遵循規則， 先定義變量賦值。
代碼總體原則 (摘抄自華爲C語言編程規範)
一、 清晰第一
清晰性是易於維護的必須具備特徵。
二、 簡潔爲美
簡潔就是易於理解並且易於實現。
選擇合適的風格， 與代碼原有風格保持一致， 如果重構、修改其他風格的代碼時， 比較明智的做法就是根據現有代碼的現有風格編寫。
頭文件
儘量單一。
A.h頭文件不要包含b.h頭文件。
禁止在頭文件中定義變量。
函數
一個函數只完整一件功能, 越小越好。
重複的代碼儘可能提煉成函數。 (講函數的時候再說)
沒有調用的代碼及時清除， 如果覺得可能會用到， 可以先註釋掉。
文件名
統一採用小寫字符。
變量名
全局變量 應增加“g_”前綴。
局部變量 應增加”s_”前綴。
儘量不要再8個字符以外， 比如clock可以寫成clk。
縮進
以四個空格縮進。
對於不同的開發工具自動生成的代碼不一致。
註釋
一般情況下， 源程序的註釋必須在%20以上。
註釋語言必須準確， 易懂， 簡潔。
文件頭部必須列出版權聲明， 版本號， 生成日期， 作者， 內容， 功能， 修改日記， 目的等。
課後作業
- 自己尋找多一些代碼規範的文章， 多去看看! 代碼規範真的! 真的! 真的! 很重要!
- 在本文下方評論(指正作者的錯誤 與 隨筆意見)， 讓作者寫出更好的文章。
