看了這麼多程式碼,談一談程式碼風格!
本週又是N皇后,又是解數獨,還來了個回溯演算法大總結,資訊量非常大,錄友們需要消化消化,所以今天聊一聊輕鬆的,但又會受用終身的內容,哈哈。
本文https://github.com/youngyangyang04/leetcode-master已經收錄,裡面還有leetcode刷題攻略、各個型別經典題目刷題順序、思維導圖,可以fork到自己倉庫,有空看一看一定會有所收穫,如果對你有幫助也給一個star支援一下吧!
其實在交流群裡經常能看到大家發出來的程式碼,可以看出很多錄友對程式碼規範應該不甚瞭解,程式碼看起來並不舒服。
所以呢,我給大家講一講程式碼規範,我主要以C++程式碼為例。
需要強調一下,程式碼規範並不是僅僅是讓程式碼看著舒服,這是一個很重要的習慣。
題外話
工作之後,「特別是在大廠,看誰的技術牛不牛逼,不用看誰寫出多牛逼的程式碼,就程式碼風格掃一眼,立刻就能看出來是正規軍還是野生程式設計師」。
很多人甚至不屑於瞭解程式碼規範,認為實現功能就行,這種觀點其實在上個世紀是很普遍的,因為那時候一般寫程式碼不需要合作,自己一個人擼整個專案,想怎麼寫就怎麼寫。
現在一些小公司,甚至大公司裡的某些技術團隊也不注重程式碼規範,趕進度擼出功能就完事,這種情況就要分兩方面看:
- 第一種情況:這個專案在業務上賺到錢了,每年年終好幾十萬,那專案前期還關心啥程式碼風格,趕進度把功能擼出來,賺錢就完事了,例如15年的王者榮耀。
- 第二種情況:這個專案沒賺到錢,半死不活的,程式碼還沒有設計也沒有規範,這樣對技術人員的傷害就非常大了。
「而不注重程式碼風格的團隊,99.99%都是第二種情況」,如果你趕上了第一種情況,那就恭喜你了,本文下面的內容可以不用看了,哈哈。
程式碼規範
變數命名
這裡我簡單說一說規範問題。
「權威的C++規範以Google為主」,我給大家下載了一份中文版本,在公眾號「程式碼隨想錄」後臺回覆:googlec++程式設計規範,就可以領取。
「具體的規範要以自己團隊風格為主」,融入團隊才是最重要的。
我先來說說變數的命名。
主流有如下三種變數規則:
- 小駝峰、大駝峰命名法
- 下劃線命名法
- 匈牙利命名法
小駝峰,第一個單詞首字母小寫,後面其他單詞首字母大寫。例如int myAge;
大駝峰法把第一個單詞的首字母也大寫了。例如:int MyAge;
通常來講 java和go都使用駝峰,C++的函式和結構體命名也是用大駝峰,「大家可以看到題解中我的C++程式碼風格就是小駝峰,因為leetcode上給出的預設函式的命名就是小駝峰,所以我入鄉隨俗」。
下劃線命名法是名稱中的每一個邏輯斷點都用一個下劃線來標記,例如:int my_age
,「下劃線命名法是隨著C語言的出現流行起來的,如果大家看過UNIX高階程式設計或者UNIX網路程式設計,就會發現大量使用這種命名方式」。
匈牙利命名法是:變數名 = 屬性 + 型別 + 物件描述,例如:int iMyAge
,這種命名是一個來此匈牙利的程式設計師在微軟內部推廣起來,然後推廣給了全世界的Windows開發人員。
這種命名方式在沒有IDE的時代,可以很好的提醒開發人員遍歷的意義,例如看到iMyAge,就知道它是一個int型的變數,而不用找它的定義,缺點是一旦該變數的屬性,那麼整個專案裡這個變數名字都要改動,所以帶來程式碼維護困難。
「目前IDE已經很發達了,都不用標記變數屬性了,IDE就會幫我們識別了,所以基本沒人用匈牙利命名法了」,雖然我不用IDE,VIM大法好。
我做了一下總結如圖:
水平留白(程式碼空格)
經常看到有的同學的程式碼都堆在一起,看起來都費勁,或者是有的間隔有空格,有的沒有空格,很不統一,有的同學甚至為了讓程式碼精簡,把所有空格都省略掉了。
大家如果注意我題解上的程式碼風格,我的空格都是有統一規範的。
「我所有題解的C++程式碼,都是嚴格按照Google C++程式設計規範來的,這樣程式碼看起來就讓人感覺清爽一些」。
我舉一些例子:
操作符左右一定有空格,例如
i = i + 1;
分隔符(,
和;
)前一位沒有空格,後一位保持空格,例如:
int i, j;
for (int fastIndex = 0; fastIndex < nums.size(); fastIndex++)
花括號和函式保持同一行,並有一個空格例如:
while (n) {
n--;
}
控制語句(while,if,for)前都有一個空格,例如:
while (n) {
if (k > 0) return 9;
n--;
}
以下是我剛寫的力扣283.移動零的程式碼,大家可以看一下整體風格,注意空格的細節!
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;
}
}
};
當然我並不是說一定要按照Google的規範來,程式碼風格其實統一就行,沒有嚴格的說誰對誰錯。
總結
如果還是學生,使用C++的話,可以按照題解中我的程式碼風格來,還是比較標準的。
如果不是C++就自己選一種程式碼風格堅持下來,
如果已經工作的錄友,就要融入團隊的程式碼風格了,團隊怎麼寫,自己就怎麼來,畢竟不是一個人在戰鬥。
就醬,以後我還會陸續分享,關於程式碼,求職,學習工作之類的內容。
我是程式設計師Carl,可以找我組隊刷題,更多精彩演算法文章盡在公眾號:程式碼隨想錄,關注後就會發現和「程式碼隨想錄」相見恨晚!
如果感覺對你有幫助,不要吝嗇給一個 吧!