寫好函數(shù)之要

我們每個人剛開始編程寫代碼時锐想,函數(shù)總是寫得冗長而復(fù)雜,有太多的縮進(jìn)和嵌套循環(huán)乍狐,有過長的參數(shù)列表赠摇。函數(shù)名稱是隨意取的,也會有重復(fù)代碼出現(xiàn)在不同函數(shù)體中浅蚪。但是藕帜,這沒有關(guān)系,寫好函數(shù)重在細(xì)節(jié)+耐心打磨惜傲。我們需要多幾次分解函數(shù)洽故,修改函數(shù)名稱,消除重復(fù)盗誊,重新安置函數(shù)时甚,甚至拆散類。打磨函數(shù)哈踱,規(guī)范代碼本身就是工匠精神的體現(xiàn)荒适,所以這一切很正常。

如何寫好代碼中的函數(shù)开镣?也許我們需要注意這些刀诬。

短小

俗話說:函數(shù)的第一規(guī)則是短小,第二規(guī)則是還要更短小邪财。保證一個函數(shù)只做一件事陕壹,它最長不過20行左右。

在遇到if語句卧蜓,else語句帐要,while語句等,其中的代碼應(yīng)該只保持一行弥奸。該行大抵是一個函數(shù)調(diào)用語句榨惠。這樣不但能保持函數(shù)短小,而且,塊內(nèi)調(diào)用的函數(shù)擁有較為具體說明性的名稱赠橙,從而增加了代碼的可讀性耽装。這樣,函數(shù)的縮進(jìn)層級不該多于一層或兩層期揪。

只做一件事

函數(shù)應(yīng)該只做一件事掉奄。編寫函數(shù)是為了把大一些的概念拆分為另一抽象層上的一系列步驟。函數(shù)只做一件事指的是在函數(shù)本身這一抽象層級上的一件事兒凤薛,具體的實現(xiàn)步驟姓建,可以通過實現(xiàn)下一層級的函數(shù)來調(diào)用。

如果函數(shù)還可以拆分出另一個函數(shù)或者可以被劃分為多個區(qū)段缤苫,則該函數(shù)違反了"一件事"原則速兔。

每個函數(shù)一個抽象層級

函數(shù)中的語句都要在統(tǒng)一抽象層級上,你可能會調(diào)用某個較高層級的函數(shù)活玲,例如實現(xiàn)貓圖像識別的函數(shù)涣狗,但在該函數(shù)底部卻輸出該圖像到磁盤上。調(diào)用貓識別的函數(shù)抽象較高舒憾,后面輸出太過于具體镀钓,違反了"一個抽象層級"的原則。

switch語句

盡量避免使用switch語句镀迂,switch語句太長丁溅,它明顯做了不止一件事。如果無法避免switch招拙,盡量讓每個分支在統(tǒng)一抽象級上唧瘾。

使用描述性名稱

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

函數(shù)參數(shù)

函數(shù)參數(shù)理想情況為0個求豫,其次是1個,再次是2個诉稍,盡量避免3個蝠嘉。函數(shù)參數(shù)最好不作為返回值。如果確實有很多內(nèi)容需要作為參數(shù)傳進(jìn)函數(shù)杯巨,可以歸納參數(shù)的一致性并封裝成類蚤告,作為對象傳進(jìn)函數(shù)。

分割指令和詢問

函數(shù)要么做了一件事服爷,要么用于判斷一件事杜恰。一個函數(shù)最好不要同時把做的事情和需要判斷的條件放在一個函數(shù)體中获诈。這屬于兩件事。

避免重復(fù)

不同的函數(shù)體中如果出現(xiàn)相同或者相似功能的語句心褐,最好抽象成函數(shù)統(tǒng)一起來舔涎,避免代碼冗余。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末逗爹,一起剝皮案震驚了整個濱河市亡嫌,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌掘而,老刑警劉巖挟冠,帶你破解...
    沈念sama閱讀 206,311評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異镣屹,居然都是意外死亡圃郊,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,339評論 2 382
  • 文/潘曉璐 我一進(jìn)店門女蜈,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人色瘩,你說我怎么就攤上這事伪窖。” “怎么了居兆?”我有些...
    開封第一講書人閱讀 152,671評論 0 342
  • 文/不壞的土叔 我叫張陵覆山,是天一觀的道長。 經(jīng)常有香客問我泥栖,道長簇宽,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,252評論 1 279
  • 正文 為了忘掉前任吧享,我火速辦了婚禮魏割,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘钢颂。我一直安慰自己钞它,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 64,253評論 5 371
  • 文/花漫 我一把揭開白布殊鞭。 她就那樣靜靜地躺著遭垛,像睡著了一般。 火紅的嫁衣襯著肌膚如雪操灿。 梳的紋絲不亂的頭發(fā)上锯仪,一...
    開封第一講書人閱讀 49,031評論 1 285
  • 那天,我揣著相機(jī)與錄音趾盐,去河邊找鬼庶喜。 笑死小腊,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的溃卡。 我是一名探鬼主播溢豆,決...
    沈念sama閱讀 38,340評論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼瘸羡!你這毒婦竟也來了漩仙?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 36,973評論 0 259
  • 序言:老撾萬榮一對情侶失蹤犹赖,失蹤者是張志新(化名)和其女友劉穎队他,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體峻村,經(jīng)...
    沈念sama閱讀 43,466評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡麸折,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 35,937評論 2 323
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了粘昨。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片垢啼。...
    茶點故事閱讀 38,039評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖张肾,靈堂內(nèi)的尸體忽然破棺而出芭析,到底是詐尸還是另有隱情,我是刑警寧澤吞瞪,帶...
    沈念sama閱讀 33,701評論 4 323
  • 正文 年R本政府宣布馁启,位于F島的核電站,受9級特大地震影響芍秆,放射性物質(zhì)發(fā)生泄漏惯疙。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,254評論 3 307
  • 文/蒙蒙 一妖啥、第九天 我趴在偏房一處隱蔽的房頂上張望霉颠。 院中可真熱鬧,春花似錦迹栓、人聲如沸掉分。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,259評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽酥郭。三九已至,卻和暖如春愿吹,著一層夾襖步出監(jiān)牢的瞬間不从,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,485評論 1 262
  • 我被黑心中介騙來泰國打工犁跪, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留椿息,地道東北人歹袁。 一個月前我還...
    沈念sama閱讀 45,497評論 2 354
  • 正文 我出身青樓,卻偏偏與公主長得像寝优,于是被迫代替她去往敵國和親条舔。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 42,786評論 2 345

推薦閱讀更多精彩內(nèi)容