iOS 編碼規(guī)范和編碼習慣

  • 使用4個空格進行縮進。(可在Xcode的Preferences中進行設(shè)置)
  • 左大括號寫在首行。eg:
class TestClass {
    /* ... */
}
  • 二元運算符前后添加空格。eg:
let testValue = 1 + 2
  • 添加有必要的注釋(使用Xcode注釋快捷鍵)。eg:
// 測試按鈕
var testBtn:UIButton
/// <#Description#>
///
/// - Parameter testValue: <#testValue description#>
/// - Returns: <#return value description#>
func testFunction(testValue: Int) -> Int {
    /*...*/
}
  • 圖片命名要清晰。eg:


    與功能相對應命名圖片
  • 變量命名應該能推斷出該變量類型,或以變量類型結(jié)尾。eg:
let coverImageView: UIImageView
let firstName: String
  • 接口命名與后臺所提供的保持一直,由請求路徑、接口名和請求后綴組成。 eg:


    GetVipColors接口.jpg
  • 接口的請求建議一次封裝多處使用,尤其是像獲取用戶信息這種。eg:


    對GetVipColors接口的封裝.jpg
  • 類型多時使用枚舉,枚舉名字和功能對應 eg:
/// 房間類型
///
/// - common: 普通模式
/// - handPattern: 相親
/// - pkPattern: 團戰(zhàn)
enum RoomShowType:String {
    case common = "common"
    case handPattern = "hand_pattern"
    case pkPattern = "pk_pattern"
}
  • 可選型使用guard或者if let解包后使用。eg:
// guard 解包
guard let giftView = giftViewArr[toMicId] else {return}
// if let 解包
if let giftView = giftViewArr[toMicId] {
}
// if let 解包多個
if let subview = subview, let volume = volume {
}
  • block的執(zhí)行如果存在延遲,需要用weak來規(guī)避強引用。 eg:
DispatchQueue.main.asyncAfter(deadline: .now() + 2) { [weak self] in
    if let weakself = self{
        weakself.rainLayer.birthRate = 0
    }
}
  • 使用// MARK: - XXX進行分組。eg:
/// MARK: - System
// MARK: - Public
// MARK: - Action
// MARK: - Private
// MARK: - xxxDelegate
  • 控制代碼段大小(比如有一個100行的代碼塊,其中50行代碼是實現(xiàn)了某個動畫,則把這50行代碼封裝為另一個代碼塊)
  • 較大功能或邏輯的修改,最好標記一下。eg:
// modified by FangLin 2018-01-01
  • 在取可變數(shù)組中的元素時,要考慮數(shù)組越界的情況。
  • 修改后的代碼要進行編譯驗證。
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關(guān)閱讀更多精彩內(nèi)容

  • 1、通過CocoaPods安裝項目名稱項目信息 AFNetworking網(wǎng)絡請求組件 FMDB本地數(shù)據(jù)庫組件 SD...
    陽明AI閱讀 16,175評論 3 119
  • “再超凡脫俗的人也離不開柴米油鹽,因為風花雪月吃不飽。” ??? 想了想為什么想要寫流水賬一般細碎無章的日記,而...
    不吃魚的小多肉閱讀 243評論 0 0
  • 這幾天我讀了幾位作者的文章之后,發(fā)現(xiàn)了自己很多的不足。在這里不想過多贅述。 真是無知者無畏啊!我竟能無視自己的淺顯...
    高樓獨倚閱讀 346評論 9 8
  • 1
    壬幾A閱讀 99評論 0 0
  • 2017.8.30今天猶豫我媽身體不舒服,我把瑜珊送去我就回媽家了,回家整整一天,中午放學她跟爸爸一起吃的飯。晚上...
    瑜珊媽媽閱讀 213評論 0 0

友情鏈接更多精彩內(nèi)容