[[353234]]

❝本周又是N皇后，又是解數(shù)獨(dú)，還來(lái)了個(gè)回溯算法大總結(jié)，信息量非常大，錄友們需要消化消化，所以今天聊一聊輕松的，但又會(huì)受用終身的內(nèi)容，哈哈。❞

其實(shí)在交流群里經(jīng)常能看到大家發(fā)出來(lái)的代碼，可以看出很多錄友對(duì)代碼規(guī)范應(yīng)該不甚了解，代碼看起來(lái)并不舒服。

所以呢，我給大家講一講代碼規(guī)范，我主要以C++代碼為例。

需要強(qiáng)調(diào)一下，代碼規(guī)范并不是僅僅是讓代碼看著舒服，這是一個(gè)很重要的習(xí)慣。

題外話

工作之后，「特別是在大廠，看誰(shuí)的技術(shù)牛不牛逼，不用看誰(shuí)寫(xiě)出多牛逼的代碼，就代碼風(fēng)格掃一眼，立刻就能看出來(lái)是正規(guī)軍還是野生程序員」。

很多人甚至不屑于了解代碼規(guī)范，認(rèn)為實(shí)現(xiàn)功能就行，這種觀點(diǎn)其實(shí)在上個(gè)世紀(jì)是很普遍的，因?yàn)槟菚r(shí)候一般寫(xiě)代碼不需要合作，自己一個(gè)人擼整個(gè)項(xiàng)目，想怎么寫(xiě)就怎么寫(xiě)。

現(xiàn)在一些小公司，甚至大公司里的某些技術(shù)團(tuán)隊(duì)也不注重代碼規(guī)范，趕進(jìn)度擼出功能就完事，這種情況就要分兩方面看：

• 第一種情況：這個(gè)項(xiàng)目在業(yè)務(wù)上賺到錢(qián)了，每年年終好幾十萬(wàn)，那項(xiàng)目前期還關(guān)心啥代碼風(fēng)格，趕進(jìn)度把功能擼出來(lái)，賺錢(qián)就完事了，例如15年的王者榮耀。
• 第二種情況：這個(gè)項(xiàng)目沒(méi)賺到錢(qián)，半死不活的，代碼還沒(méi)有設(shè)計(jì)也沒(méi)有規(guī)范，這樣對(duì)技術(shù)人員的傷害就非常大了。這種例子比比皆是。

「而不注重代碼風(fēng)格的團(tuán)隊(duì)，99.99%都是第二種情況」，如果你趕上了第一種情況，那就恭喜你了，本文下面的內(nèi)容可以不用看了，哈哈。

代碼規(guī)范

變量命名

這里我簡(jiǎn)單說(shuō)一說(shuō)規(guī)范問(wèn)題。

「權(quán)威的C++規(guī)范以Google為主」，我給大家下載了一份中文版本，在公眾號(hào)「代碼隨想錄」后臺(tái)回復(fù)：googlec++編程規(guī)范，就可以領(lǐng)取。

「具體的規(guī)范要以自己團(tuán)隊(duì)風(fēng)格為主」，融入團(tuán)隊(duì)才是最重要的。

我先來(lái)說(shuō)說(shuō)變量的命名。

主流有如下三種變量規(guī)則：

• 小駝峰、大駝峰命名法
• 下劃線命名法
• 匈牙利命名法

小駝峰，第一個(gè)單詞首字母小寫(xiě)，后面其他單詞首字母大寫(xiě)。例如 int myAge;大駝峰法把第一個(gè)單詞的首字母也大寫(xiě)了。例如：int MyAge;通常來(lái)講 java和go都使用駝峰，C++的函數(shù)和結(jié)構(gòu)體命名也是用大駝峰，「大家可以看到題解中我的C++代碼風(fēng)格就是小駝峰，因?yàn)閘eetcode上給出的默認(rèn)函數(shù)的命名就是小駝峰，所以我入鄉(xiāng)隨俗」。

下劃線命名法是名稱中的每一個(gè)邏輯斷點(diǎn)都用一個(gè)下劃線來(lái)標(biāo)記，例如：int my_age，「下劃線命名法是隨著C語(yǔ)言的出現(xiàn)流行起來(lái)的，如果大家看過(guò)UNIX高級(jí)編程或者UNIX網(wǎng)絡(luò)編程，就會(huì)發(fā)現(xiàn)大量使用這種命名方式」。

匈牙利命名法是：變量名 = 屬性 + 類(lèi)型 + 對(duì)象描述，例如：int iMyAge，這種命名是一個(gè)來(lái)此匈牙利的程序員在微軟內(nèi)部推廣起來(lái)，然后推廣給了全世界的Windows開(kāi)發(fā)人員。

這種命名方式在沒(méi)有IDE的時(shí)代，可以很好的提醒開(kāi)發(fā)人員遍歷的意義，例如看到iMyAge，就知道它是一個(gè)int型的變量，而不用找它的定義，缺點(diǎn)是一旦該變量的屬性，那么整個(gè)項(xiàng)目里這個(gè)變量名字都要改動(dòng)，所以帶來(lái)代碼維護(hù)困難。

「目前IDE已經(jīng)很發(fā)達(dá)了，都不用標(biāo)記變量屬性了，IDE就會(huì)幫我們識(shí)別了，所以基本沒(méi)人用匈牙利命名法了」，雖然我不用IDE，VIM大法好。

我做了一下總結(jié)如圖：

編程風(fēng)格

水平留白(代碼空格)經(jīng)常看到有的同學(xué)的代碼都堆在一起，看起來(lái)都費(fèi)勁，或者是有的間隔有空格，有的沒(méi)有空格，很不統(tǒng)一，有的同學(xué)甚至為了讓代碼精簡(jiǎn)，把所有空格都省略掉了。

大家如果注意我題解上的代碼風(fēng)格，我的空格都是有統(tǒng)一規(guī)范的。

「我所有題解的C++代碼，都是嚴(yán)格按照Google C++編程規(guī)范來(lái)的，這樣代碼看起來(lái)就讓人感覺(jué)清爽一些」。

我舉一些例子：

操作符左右一定有空格，例如

i = i + 1; 

分隔符(, 和;)前一位沒(méi)有空格，后一位保持空格，例如：

int i, j; 
for (int fastIndex = 0; fastIndex < nums.size(); fastIndex++)  

花括號(hào)和函數(shù)保持同一行，并有一個(gè)空格例如：

while (n) {  
    n--; 
} 

控制語(yǔ)句(while，if，for)前都有一個(gè)空格，例如：

while (n) {  
    if (k > 0) return 9; 
    n--; 
} 

以下是我剛寫(xiě)的力扣283.移動(dòng)零的代碼，大家可以看一下整體風(fēng)格，注意空格的細(xì)節(jié)!

class Solution { 
public: 
    void moveZeroes(vector<int>& nums) { 
        int slowIndex = 0; 
        for (int fastIndex = 0; fastIndex < nums.size(); fastIndex++) { 
            if (nums[fastIndex] != 0) { 
                nums[slowIndex++] = nums[fastIndex]; 
            } 
        } 
        for (int i = slowIndex; i < nums.size(); i++) { 
            nums[i] = 0; 
        } 
    } 
}; 

當(dāng)然我并不是說(shuō)一定要按照Google的規(guī)范來(lái)，代碼風(fēng)格其實(shí)統(tǒng)一就行，沒(méi)有嚴(yán)格的說(shuō)誰(shuí)對(duì)誰(shuí)錯(cuò)。

總結(jié)

如果還是學(xué)生，使用C++的話，可以按照題解中我的代碼風(fēng)格來(lái)，還是比較標(biāo)準(zhǔn)的。

如果不是C++就自己選一種代碼風(fēng)格堅(jiān)持下來(lái)，

如果已經(jīng)工作的錄友，就要融入團(tuán)隊(duì)的代碼風(fēng)格了，團(tuán)隊(duì)怎么寫(xiě)，自己就怎么來(lái)，畢竟不是一個(gè)人在戰(zhàn)斗。

本文轉(zhuǎn)載自微信公眾號(hào)「 代碼隨想錄  」，可以通過(guò)以下二維碼關(guān)注。轉(zhuǎn)載本文請(qǐng)聯(lián)系 代碼隨想錄  公眾號(hào)。

 本文轉(zhuǎn)載自微信公眾號(hào)「 代碼隨想錄  」，可以通過(guò)以下二維碼關(guān)注。轉(zhuǎn)載本文請(qǐng)聯(lián)系 代碼隨想錄  公眾號(hào)。