Swift 風格指南

當我們編寫這本書,或者在我們自己的項目中使用 Swift 代碼時,我們盡量遵循如下的原則:

  • 對于命名,在使用時能清晰表意是最重要。因為 API 被使用的次數要遠遠多于被聲明的次數,所以我們應當從使用者的角度來考慮它們的名字。盡快熟悉 Swift API 設計準則,并且在你自己的代碼中堅持使用這些準則。

  • 簡潔經常有助于代碼清晰,但是簡潔本身不應該獨自成為我們編碼的目標。

  • 務必為函數添加文檔注釋 — 特別是泛型函數。

  • 類型使用大寫字母開頭,函數、變量和枚舉成員使用小寫字母開頭,兩者都使用駝峰式命名法。

  • 使用類型推斷。省略掉顯而易見的類型會有助于提高可讀性。

  • 如果存在歧義或者在進行定義的時候不要使用類型推斷。(比如 func 就需要顯式地指定返回類型)

  • 優先選擇結構體,只在確實需要使用到類特有的特性或者是引用語義時才使用類。

  • 除非你的設計就是希望某個類被繼承使用,否則都應該將它們標記為 final。

  • 除非一個閉包后面立即跟隨有左括號,否則都應該使用尾隨閉包 (trailing closure) 的語法。

  • 使用 guard 來提早退出方法。

  • 避免對可選值進行強制解包和隱式強制解包。它們偶爾有用,但是經常需要使用它們的話往往意味著有其他不妥的地方。

  • 不要寫重復的代碼。如果你發現你寫了好幾次類似的代碼片段的話,試著將它們提取到一個函數里,并且考慮將這個函數轉化為協議擴展的可能性。

  • 試著去使用 map 和 reduce,但這不是強制的。當合適的時候,使用 for 循環也無可厚非。高階函數的意義是讓代碼可讀性更高。但是如果使用 reduce 的場景難以理解的話,強行使用往往事與愿違,這種時候簡單的 for 循環可能會更清晰。

  • 試著去使用不可變值:除非你需要改變某個值,否則都應該使用 let 來聲明變量。不過如果能讓代碼更加清晰高效的話,也可以選擇使用可變的版本。用函數將可變的部分封裝起來,可以把它帶來的副作用進行隔離。

  • Swift 的泛型可能會導致非常長的函數簽名。壞消息是我們現在除了將函數聲明強制寫成幾行以外,對此并沒有什么好辦法。我們會在示例代碼中在這點上保持一貫性,這樣你能看到我們是如何處理這個問題的。

  • 除非你確實需要,否則不要使用 self.。在閉包表達式中,使用 self 是一個清晰的信號,表明閉包將會捕獲 self。

  • 盡可能地對現有的類型和協議進行擴展,而不是寫一些全局函數。這有助于提高可讀性,讓別人更容易發現你的代碼。

摘自喵神

https://objccn.io/products/advanced-swift/preview/

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

推薦閱讀更多精彩內容