制定自己的Swift編碼規(guī)范

警告

盡量將所有警告都處理掉郑气。

命名

1.使用具有描述性的名稱萍嬉,
2.使用駝峰式命名規(guī)則給類方法和變量等命名乌昔。
3.類別名稱(類,結構體壤追,枚舉和協(xié)議)首字母大寫磕道,方法或者變量的首字母小寫。

// 常量
private let maximumWidgetCount = 100

// 方法
func setupWidget() ->{
    print("ok")
}

// 類
class WidgetContainer {
    var widgetButton: UIButton  
    let  widgetHeightPercentage = 0.85
}

縮進

1.使用四個空格進行縮進
2.每行最多160個字符行冰,這樣可以避免一行過長溺蕉。
3.確保每個文件結尾都有空白行。
4.代碼結尾不要使用分號;
5.在逗號后面加一個空格

let numberArray = [1, 3, 6, 10]

6.不要使用 as! 或 try!
推薦

// 使用if let as悼做?判斷
if let text = text as? String {
    /* ... */
}

// 使用if let try 或者 try?
if let test = try aTryFuncton() {
    /* ... */
}

Closure Expressions(閉包表達式)
閉包放在最后面

// Preferred(推薦)
UIView.animateWithDuration(1.0) {
  self.myView.alpha = 0
}

UIView.animateWithDuration(1.0,
  animations: {
    self.myView.alpha = 0
  },
  completion: { finished in
    self.myView.removeFromSuperview()
  }
)

// Not Preferred(不推薦)
UIView.animateWithDuration(1.0, animations: {
  self.myView.alpha = 0
})

UIView.animateWithDuration(1.0,
  animations: {
    self.myView.alpha = 0
  }) { f in
    self.myView.removeFromSuperview()
}

7.命名應該具有描述性 和 清晰的疯特。
不要縮寫,簡寫命名肛走,或用單個字母命名漓雅。
如果原有命名不能明顯表明類型,則屬性命名內要包括類型信息朽色。

// 推薦
class RoundAnimatingButton: UIButton { /* ... */ }
// 不推薦
class CustomButton: UIButton { /* ... */ }

// 推薦
class ConnectionTableViewCell: UITableViewCell {
    //這個不是 UIImage, 不應該以Image 為結尾命名邻吞。
    ?let personImageView: UIImageView
    ?let personImage: UIImageView 
   
    // 建議使用 animationDuration 或 animationTimeInterval
    ?let animationDuration: NSTimeInterval
    ?let animation: NSTimeInterval

    // transition 不能清晰表達出是String
    ?let transitionText: String
    ?let transitionString: String
    ?let transition: String

    // 作為屬性名的firstName,很明顯是字符串類型纵搁,所以不用在命名里不用包含String
    ?let firstName: String
    ?let firstNameLabel: UILabel

    // 因用snapkit來布局吃衅,頁面默認都是ViewController, 所以這個簡化
    ?let testController: UIViewController

    // 當使用outlets時, 確保命名中標注類型腾誉。為了保持一致性,建議把類型放到變量的結尾峻呕,而不是開始利职,如submitButton
    ?@IBOutlet weak var submitButton: UIButton!
    ?@IBOutlet weak var emailTextField: UITextField!
    ?@IBOutlet weak var nameLabel: UILabel!

    // 常量統(tǒng)一用全大寫,下劃線連線
    enum Dict: String {
        case AAA_BBB
        case CCC_DDD
    }

    // Localizable.strings
    "ALERT_TITLE" = "測試";
    "ALERT_CONTENT_UNLOGIN" = "請登錄";
    "ALERT_ACTION_OK" = "好的";
    "ALERT_ACTION_CANCEL" = "取消";
}
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末瘦癌,一起剝皮案震驚了整個濱河市猪贪,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌讯私,老刑警劉巖热押,帶你破解...
    沈念sama閱讀 218,858評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異斤寇,居然都是意外死亡桶癣,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,372評論 3 395
  • 文/潘曉璐 我一進店門娘锁,熙熙樓的掌柜王于貴愁眉苦臉地迎上來牙寞,“玉大人,你說我怎么就攤上這事〖淙福” “怎么了悔详?”我有些...
    開封第一講書人閱讀 165,282評論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長惹挟。 經常有香客問我茄螃,道長,這世上最難降的妖魔是什么连锯? 我笑而不...
    開封第一講書人閱讀 58,842評論 1 295
  • 正文 為了忘掉前任责蝠,我火速辦了婚禮,結果婚禮上萎庭,老公的妹妹穿的比我還像新娘霜医。我一直安慰自己,他們只是感情好驳规,可當我...
    茶點故事閱讀 67,857評論 6 392
  • 文/花漫 我一把揭開白布肴敛。 她就那樣靜靜地躺著,像睡著了一般吗购。 火紅的嫁衣襯著肌膚如雪医男。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,679評論 1 305
  • 那天捻勉,我揣著相機與錄音镀梭,去河邊找鬼。 笑死踱启,一個胖子當著我的面吹牛报账,可吹牛的內容都是我干的。 我是一名探鬼主播埠偿,決...
    沈念sama閱讀 40,406評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼透罢,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了冠蒋?” 一聲冷哼從身側響起羽圃,我...
    開封第一講書人閱讀 39,311評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎抖剿,沒想到半個月后朽寞,有當地人在樹林里發(fā)現(xiàn)了一具尸體,經...
    沈念sama閱讀 45,767評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡斩郎,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,945評論 3 336
  • 正文 我和宋清朗相戀三年脑融,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片孽拷。...
    茶點故事閱讀 40,090評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡吨掌,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情膜宋,我是刑警寧澤窿侈,帶...
    沈念sama閱讀 35,785評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站秋茫,受9級特大地震影響史简,放射性物質發(fā)生泄漏。R本人自食惡果不足惜肛著,卻給世界環(huán)境...
    茶點故事閱讀 41,420評論 3 331
  • 文/蒙蒙 一圆兵、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧枢贿,春花似錦殉农、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,988評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至耀态,卻和暖如春轮傍,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背首装。 一陣腳步聲響...
    開封第一講書人閱讀 33,101評論 1 271
  • 我被黑心中介騙來泰國打工创夜, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人仙逻。 一個月前我還...
    沈念sama閱讀 48,298評論 3 372
  • 正文 我出身青樓驰吓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親桨醋。 傳聞我的和親對象是個殘疾皇子棚瘟,可洞房花燭夜當晚...
    茶點故事閱讀 45,033評論 2 355

推薦閱讀更多精彩內容

  • 1. 從網絡文學和手機閱讀現(xiàn)狀談談我國大眾出版的發(fā)展趨勢。2. 請以“紙質出版喜最,依然很美”為題,論述數字時代印刷型...
    華夢初歇閱讀 595評論 0 0
  • 自從16年9月長穿完畢&四姑娘2峰下來后, 發(fā)現(xiàn)自己心臟簡直是龜速. 于是, 基于珍愛生命原則, 要好好監(jiān)測監(jiān)測....
    Amy嫻閱讀 492評論 0 0
  • https://ntrs.nasa.gov/archive/nasa/casi.ntrs.nasa.gov/200...
    hydro閱讀 1,159評論 0 0
  • 據說人品好的人在電腦上點下面的藍字庄蹋,一定會看到我連載小說中的某一章節(jié)瞬内,人品不好的就很難說了。大爺限书,來試試俺娴! 點這...
    喪心病狂的小堅果兒閱讀 980評論 21 13
  • 這里有一扇門 請你輕輕地關上 就像呵護一個剛剛睡去的嬰兒 傾注了你的全部母愛 請你慢慢 默默地關上這扇門 把寧靜留...
    凡塵葦子閱讀 366評論 2 2