前言:
俗話說:沒有規矩,不成方圓。我們寫代碼也是一樣,代碼規範就是我們寫代碼的規矩。舉個簡單的例子,我們在公司開發完一版軟件之後,因爲軟件要優化、迭代。公司有很多人來參加這個項目,其他要想輕鬆上手,首先他們要看懂我們的代碼,如果我們寫的代碼只有自己能看懂,那麼會給公司帶來很大的麻煩,我們自己在編程之路上也是很難存活下去的。
正文:
說道代碼規範,我們先看看它的優點:
1.規範的代碼可以減少很多的bug.
2.統一規範,方便閱讀、維護,提高代碼質量
3.統一格式,使代碼度量更加精確,爲公司軟件過程體系優化打好基礎,爲後續交接工作提供依據。
4.節省很多的時間
5.節省很多的成本
我們看了代碼規範有這麼多優點,那趕快學學怎麼讓代碼更加規範吧。
一、首先就是命名規範
1.1 命名原則
- 名字應該能夠標識事物的特性,並且與業務掛鉤。
- 名字一律使用英文單詞,而不能爲拼音。
- 名字可以有兩個或三個單詞組成,但不應多於4個,控制在3至30個字母以內。
- 在名字中,多個單詞用大寫第一個字母(其它字母小寫)來分隔。例如:IsSuperUser。
- 命名避免和以下關鍵字衝突
- 方法名、參數名統一使用駝峯命名法(Camel命名法),除首字母外,其他單詞的首字母大寫,其他字母小寫,類名每個組合的單詞都要大寫;
- 所有變量、方法、類名:見名知意
- 類成員變量:首字母小寫和駝峯原則: monthSalary
- 局部變量:首字母小寫和駝峯原則
- 常量:大寫字母和下劃線:MAX_VALUE
- 類名:首字母大寫和駝峯原則: Man, GoodMan
- 方法名:首字母小寫和駝峯原則: run(), runRun()
1.2 註釋(三種)
單行註釋:
“//……”
塊註釋:
“/*……*/”
文檔註釋:
“/**……*/”
1.3 編碼風格規則
編碼過程中需遵循以下風格習慣:
代碼未寫,文檔先行,註釋必須按照固定統一範式撰寫。
關係運算必須常量在左、變量在右。
不許使用複雜的運算表達式,必要時添加括號而不依賴於優先級。
魔鬼數字需用宏定義替代。
局部變量必須初定義、避免不必要的內存操作、內存操作必須考慮異常處理。
1.4 版本命名規範
當源碼包初版時,版本號爲 V1.00;
當源碼包被局部修改或bug修正時,發行號不變,修改號第二個數字增1。例如,對初版源碼包作了第一次修訂,則版本號爲 V1.01;
當源碼包在原有的基礎上增加部分功能,發行號不變,修改號第一個數字增1,例如,對V1.12版的基礎上增加部分功能,則新版本號爲 V1.20;
當源碼包有重要修改或局部修訂累積較多導致源碼包發生全局變化時,發行號增1。例如,在 V1.15 版的基礎上作了一次全面修改,則新版本號爲 V2.00。
有了代碼規範,我們寫代碼輕鬆了許多,也給其他人帶來了很多方便,何樂而不爲呢!