寫好函數之要

我們每個人剛開始編程寫代碼時,函數總是寫得冗長而復雜,有太多的縮進和嵌套循環,有過長的參數列表。函數名稱是隨意取的,也會有重復代碼出現在不同函數體中。但是,這沒有關系,寫好函數重在細節+耐心打磨。我們需要多幾次分解函數,修改函數名稱,消除重復,重新安置函數,甚至拆散類。打磨函數,規范代碼本身就是工匠精神的體現,所以這一切很正常。

如何寫好代碼中的函數?也許我們需要注意這些。

短小

俗話說:函數的第一規則是短小,第二規則是還要更短小。保證一個函數只做一件事,它最長不過20行左右。

在遇到if語句,else語句,while語句等,其中的代碼應該只保持一行。該行大抵是一個函數調用語句。這樣不但能保持函數短小,而且,塊內調用的函數擁有較為具體說明性的名稱,從而增加了代碼的可讀性。這樣,函數的縮進層級不該多于一層或兩層。

只做一件事

函數應該只做一件事。編寫函數是為了把大一些的概念拆分為另一抽象層上的一系列步驟。函數只做一件事指的是在函數本身這一抽象層級上的一件事兒,具體的實現步驟,可以通過實現下一層級的函數來調用。

如果函數還可以拆分出另一個函數或者可以被劃分為多個區段,則該函數違反了"一件事"原則。

每個函數一個抽象層級

函數中的語句都要在統一抽象層級上,你可能會調用某個較高層級的函數,例如實現貓圖像識別的函數,但在該函數底部卻輸出該圖像到磁盤上。調用貓識別的函數抽象較高,后面輸出太過于具體,違反了"一個抽象層級"的原則。

switch語句

盡量避免使用switch語句,switch語句太長,它明顯做了不止一件事。如果無法避免switch,盡量讓每個分支在統一抽象級上。

使用描述性名稱

函數一般是一個動賓短語,不用怕名稱太長,盡量保持描述性。另外,在同一抽象層級上的函數保持函數命名方式一致。

函數參數

函數參數理想情況為0個,其次是1個,再次是2個,盡量避免3個。函數參數最好不作為返回值。如果確實有很多內容需要作為參數傳進函數,可以歸納參數的一致性并封裝成類,作為對象傳進函數。

分割指令和詢問

函數要么做了一件事,要么用于判斷一件事。一個函數最好不要同時把做的事情和需要判斷的條件放在一個函數體中。這屬于兩件事。

避免重復

不同的函數體中如果出現相同或者相似功能的語句,最好抽象成函數統一起來,避免代碼冗余。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,885評論 6 541
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,312評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,993評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,667評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,410評論 6 411
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,778評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,775評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,955評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,521評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,266評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,468評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,998評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,696評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,095評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,385評論 1 294
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,193評論 3 398
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,431評論 2 378

推薦閱讀更多精彩內容