“你代碼寫得這么爛,有問過代碼是什么感受嗎?”
一,完全不能被讀懂的代碼
哎,憋了這么多天,今天我實在憋不住了!
本小姐我,快-被-一-段-代-碼-氣-炸-了!
是的,你沒看錯,惹我生氣的是一段根本就沒有生命的代碼。
但是不得不說,這段代碼有夠魔性!
一個明明沒有生命的東西,硬生生把一個活的人給惹炸毛了。
它還不夠魔性嗎?
事情的經過是這樣的。
姐姐我最近負責跟進的是一個教育類軟件的ios客戶端。
已經上線運營了,但是最近甲方領導覺得以前的ui不夠美觀,于是提出了我們這個月要做個小改版。
我看了需求,無非調調顏色,改改圖標排列,再添加幾個詳情頁。
好像也沒啥難搞的。
于是我就跟身邊一個小伙子簡單交待幾句,讓他去做這個事情。
臨了,我還不忘記叮囑了句,我們現在代碼里,這一塊之前改來改去,代碼結構有點亂,你看時間允許的話,就一起重構下吧。
就是這句話,讓我想狠抽自己嘴巴。
是的,代碼他重構過了,但是重構后的代碼,我更加看不懂了!
昨天轉測的版本,今天看到有個問題,通訊錄的列表里,有個人的電話號碼顯示不對。
粗粗一看,這不就是tableview的cell復用數據沒更新好的問題嘛?
這種小case,姐姐順手就可以給處理了。
誰知道啊,姐姐還是太年輕,就這么栽這坑里了!
當我進到這個界面的- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath函數中,一下子就傻眼了。
切切實實的陰溝里翻船的感覺。
首先,這個函數有200多行!
直接懵圈了。
但是我也不能這么久放棄,有點沒面子。
硬著頭皮往下看。
令人想不到的是,這個函數中使用的圖片資源,名字竟然還是中文!
怎么樣?有沒有要吐血的感覺?
哦,那你的承受能力就太差了些。
因為,最讓我承受不了的還不是這些。
而是這200多行的代碼竟然做的都是cell上控件的創建初始化賦值...
我實在沒法淡定啊,對著這樣的代碼,我竟然不知道還要cell對應的類干嘛。
跟幾個朋友吐槽了下,做測試的美眉說我承受不了的這條她不能理解。
我幾近咆哮的跟她講——
“你想想直接讓奶奶甩開兒子媳婦,生個孫子是什么感觸吧”
還有比這更形象的比喻了么?
肯定有人不相信我講的話,好吧,我就貼一小段給大家感受下。
ContacterDetailCell * cell = [tableView dequeueReusableCellWithIdentifier:cellId];
if (!cell) {
cell = [[ContacterDetailCell alloc]initWithStyle:UITableViewCellStyleDefault reuseIdentifier:cellId];
cell.selectionStyle = UITableViewCellSeparatorStyleNone;
}
BOOL isHasShortDn = [[[NSUserDefaults standardUserDefaults]objectForKey:KEY_ISOPEN_VNET]integerValue];
ADTIMContacter * contacter = self.contacterArray[indexPath.row];
_phoneNum = contacter.m_strDn;
cell.contentView.userInteractionEnabled = YES;
cell.shortDnLabel = [UILabel new];
cell.telLabel = [UILabel new];
cell.classNameLabel = [[UILabel alloc]initWithFrame:CGRectMake(5, 5, MAIN_WIDTH, 40)];
cell.classNameLabel.textColor = [UIColor darkGrayColor];
cell.classNameLabel.font = [UIFont systemFontOfSize:16.0];
[cell.contentView addSubview:cell.classNameLabel];
cell.publicLable = [[UILabel alloc]initWithFrame:CGRectMake(MAIN_WIDTH - 80, 135, 50, 40)];
cell.publicLable.text = contacter.m_isOpen_phone ? @"已公開":@"未公開";
cell.publicLable.textColor = [UIColor redColor];
cell.publicLable.font = [UIFont systemFontOfSize:16.0];
cell.publicLable.textAlignment = NSTextAlignmentCenter;
[cell.contentView addSubview:cell.publicLable];
UIImageView * line = [UIImageView new];
line.backgroundColor = kBWDarkGray;
[cell.contentView addSubview:line];
if ([[LoginUserUtil userId] isEqualToString:_userID[1]]) {
cell.classNameLabel.hidden = NO;
cell.classNameLabel.text = self.classNameArray[indexPath.row];
cell.shortDnLabel.frame = CGRectMake(5, 45, MAIN_WIDTH, 55);
cell.telLabel.frame = CGRectMake(5, 105, MAIN_WIDTH, 55);
line.frame = CGRectMake(0, CGRectGetMaxY(cell.shortDnLabel.frame), MAIN_WIDTH, 1);
UISwitch * my_switch = [[UISwitch alloc]initWithFrame:CGRectMake(cell.publicLable.frame.origin.x, CGRectGetMinY(cell.publicLable.frame) - 25, 0, 0)];
[my_switch setOn:contacter.m_isOpen_phone animated:YES];
[my_switch addTarget:self action:@selector(switchValueChanged:) forControlEvents:UIControlEventValueChanged];
my_switch.tag = 100 + indexPath.row;
if (!IsStrEmpty(contacter.m_strDn)) {
[cell.contentView addSubview:my_switch];
}
我就想問誰特么能把這段代碼讀完,并理解了?
我肯定是不行!
還不死心的我,又去看了看其他地方。
真心想講臟話,好嘛?
充斥滿屏的魔鬼數字,
完全不知所謂的變量命名,
不考慮屬性的使用范圍,統一采用public
不考慮內存的優化使用
......
這位大哥,你這樣寫代碼,有沒有問問代碼什么心情?
最終,我也沒找到上面所說問題的解決辦法。只好找來制造這段代碼的小哥。
沒錯,這小哥就在剛才處理完問題后,已經領了我甩給他的編碼規范去面壁了。
我曾一直天真(臭不要臉)的以為,我的團隊能做出完美的應用。經此事件,我突然感覺,對于我目前的團隊來說,做出完美的app是多么遙不可及的夢想。
我們甚至都寫不出來,能讓別人(注意,這里的別人不是所有人,而是你的同行們)看懂的代碼!
二、我們為什么寫出了不易懂的代碼?
不要問我什么是容易被別人讀懂的代碼。
你只要想想你自己去讀別人的代碼,你希望看到什么樣的代碼心中就有答案?
告訴我,你在讀代碼時
是希望看到排版整齊的,還是很隨性的?
是喜歡看變量命名使用同一規則的,還是根本就看不懂使用了什么規則的?
是更樂于看到函數的功能單一的,還是樂于看到囊括了好幾個不相關的能力的函數?
是更接受邏輯清晰的還是更接受邏輯繁復的?
是一看就知道作者意圖,還是讀了半天也不明白作者寫這段代碼要干嘛?
......
所以,你還要問我什么樣的代碼是容易被別人讀懂的嗎?
你自己心中明明早就有很明確的答案了好嗎?
你之所以寫出這么爛的代碼,無非是你對別人(一般是跟你合作項目的伙伴)有明確的要求,而對自己沒有!
完全分不清楚好代碼和爛代碼的人除外。
相信我,在你需要讀別人代碼的時候,你心中對好代碼的定義能細分到三級目錄。
然而,到你自己寫的時候,都是干脆交給編譯器,自己都懶得讀,更別說給自己的代碼套自己的標準,檢驗下是否易讀。
三、怎么寫出容易被讀懂的代碼?
怎么寫出容易讀的代碼?
方法就一個,寫完后自己去讀!
然后想象一下,別人讀這段代碼的心里感受。
當然不排除,有很多自認為大神的人,經常會寫出一些晦澀難懂的代碼,以此來彰顯自己水平牛X。
但是,請看明白,這些人都僅僅是自以為是的牛X。
真正的牛X是什么樣的?把復雜的問題用很通俗淺顯的方法解決了,那才是真正的牛X!
舉個很簡單的例子,《天龍八部》中的掃地僧,他出手時,擺什么花里胡哨的招數了嗎?沒有!
所以你是希望自己做個隨便一舉手投足都自帶功力的高手,還是做個金玉其外的花架子,選擇權在你自己。
畢竟,代碼是承載我們技術水平的東西,它跟我們沒有深仇大恨。
在敲下每行代碼的時候,我們還是稍微用點心,不要總滿足于功能似乎實現了就萬事大吉的入門級別!