看了這么多代碼,談一談代碼風格!
❝本周又是N皇后,又是解數獨,還來了個回溯算法大總結,信息量非常大,錄友們需要消化消化,所以今天聊一聊輕松的,但又會受用終身的內容,哈哈。❞
其實在交流群里經常能看到大家發出來的代碼,可以看出很多錄友對代碼規范應該不甚了解,代碼看起來并不舒服。
所以呢,我給大家講一講代碼規范,我主要以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++就自己選一種代碼風格堅持下來,
如果已經工作的錄友,就要融入團隊的代碼風格了,團隊怎么寫,自己就怎么來,畢竟不是一個人在戰斗。
本文轉載自微信公眾號「 代碼隨想錄 」,可以通過以下二維碼關注。轉載本文請聯系 代碼隨想錄 公眾號。
本文轉載自微信公眾號「 代碼隨想錄 」,可以通過以下二維碼關注。轉載本文請聯系 代碼隨想錄 公眾號。