iOS 代碼規(guī)范

目錄

    (1)Classes(項(xiàng)目功能類文件)刊橘。
    (2)Commons(常用宏定義類等公共文件)暇矫。
    (3)Utils(自定義功能類文件)主之。
    (4)Plugins(常用第三方擴(kuò)展功用類文件)择吊。
    (5)Resource(視頻\聲音等資源文件。項(xiàng)目圖標(biāo)\logo\啟動(dòng)頁等存放在 Assets.xcassets 中)槽奕。

命名規(guī)范

    VC的命名       :BLxxxxxVC
    Cell的命名     :BLxxxxxCell
    View的命名     :BLxxxxView
    彈出框View的命名:BLxxxxPopView
    管理類         :BLxxxxMangers
    UIText        :blXxxxText
    UIButton      :blXxxxButton
    UIlabe        :blXxxxLabe
    UIview        :blXxxxView
    以此類推......

    Model的命名規(guī)則:     
    BLBaseModel(基類)几睛,不夠用再擴(kuò)展-->
    BLListModel(列表),不夠用再擴(kuò)展-->
    BLDictionaryModel(字典)史翘,不夠用再擴(kuò)展-->
    BLxxxxModel(基類)
    userModel

    枚舉命名規(guī)則:
    BLXxxxPlayerStateLoading

    分類時(shí)枉长,以有意義的英文單詞結(jié)尾冀续。
    如:NSString+Regular.h琼讽、NSString+Regular.m 等。

    常量名
    (1)明確類型和值時(shí)洪唐,使用靜態(tài)變量進(jìn)行定義钻蹬。
    如:static NSString *const kDefaultPhone = @”13800138000”;
    (2)需要計(jì)算或判斷才能確定值時(shí),使用宏定義凭需。
    如:#define kMinValue(a, b) (a > b ? b : a)

    圖片/圖標(biāo)名
    導(dǎo)航條背景圖標(biāo) xxxNavigation@2x.png
    頁簽圖標(biāo) xxxTab@2x.png
    按鈕圖標(biāo) xxxBtn@2x.png
    區(qū)分不同狀態(tài)的圖標(biāo)
    點(diǎn)擊前l(fā)oginBtn_normal@2x.png
    高亮?xí)rloginBtn_highlight@2x
    選中時(shí)loginBtn_selected@2x问欠;
    禁用時(shí)loginBtn_disabled@2x。

    在需要添加注釋的代碼前一行粒蜈,使用快捷組合鍵 Cmd + Option + / 會(huì)自動(dòng)添加注釋標(biāo)識(shí)顺献。

方法名

    (1)方法不帶參數(shù)時(shí)。
    如:- (void)deleteClick;
    (2)方法帶有參數(shù)時(shí)枯怖,必須完整且清楚的定義各個(gè)參數(shù)注整。
    如:- (void)loginWithName:(NSString *)name password:(NSString *)password;
    (3)方法帶有返回值時(shí)。
    如:- (BOOL *)modifyUserName:(NSString *)name;

項(xiàng)目可維護(hù)的一些原則:

1度硝,盡可能少寫代碼
2肿轨,盡可能減少第三方依賴,除非有明確的需求
3蕊程,采用一致的代碼風(fēng)格
4椒袍,統(tǒng)一代碼布局
5,統(tǒng)一Model層
6藻茂,統(tǒng)一網(wǎng)絡(luò)請(qǐng)求方法

#pragma mark - Life Cycle
#pragma mark - 視圖
#pragma mark - 網(wǎng)絡(luò)
#pragma mark - 交互
#pragma mark - Lazy Load

    //MARK: - Life Cycle
    //MARK: -  視圖
    //MARK: - 網(wǎng)絡(luò)
    //MARK: - 交互
    //MARK: -Lazy Load

不允許直接聲明和使用實(shí)例變量驹暑,應(yīng)當(dāng)使用屬性變量

錯(cuò)誤:

@interface object{
    NSString *_name;
}
@end

正確:

@interface object

@property (nonatomic, strong) NSString *name;

@end

Delegate函數(shù)名

delegate方法四要素:
返回類型
自己
事件
反饋參數(shù)
- (void)manager:(XXManager *)manager didFailedWithErrorCode:(NSString)errorCode errorMessage:(NSString *)errorMessage;

- (void)managerTaskDidFinished:(XXManager *)manager;

delegate方法第一個(gè)參數(shù)永遠(yuǎn)都應(yīng)該是自己。

{}的使用規(guī)范

錯(cuò)誤:
- (void)foo {
    ...
}

正確:
- (void)foo
{
    ...
}

if-else中{}不換行辨赐,else中的{}不換行:

正確:
if (foo) {
    ...
} else {
    ...
}
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末岗钩,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子肖油,更是在濱河造成了極大的恐慌兼吓,老刑警劉巖,帶你破解...
    沈念sama閱讀 222,183評(píng)論 6 516
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件森枪,死亡現(xiàn)場(chǎng)離奇詭異视搏,居然都是意外死亡审孽,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,850評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門浑娜,熙熙樓的掌柜王于貴愁眉苦臉地迎上來佑力,“玉大人,你說我怎么就攤上這事筋遭〈虿” “怎么了?”我有些...
    開封第一講書人閱讀 168,766評(píng)論 0 361
  • 文/不壞的土叔 我叫張陵漓滔,是天一觀的道長编饺。 經(jīng)常有香客問我,道長响驴,這世上最難降的妖魔是什么透且? 我笑而不...
    開封第一講書人閱讀 59,854評(píng)論 1 299
  • 正文 為了忘掉前任,我火速辦了婚禮豁鲤,結(jié)果婚禮上秽誊,老公的妹妹穿的比我還像新娘。我一直安慰自己琳骡,他們只是感情好锅论,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,871評(píng)論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著楣号,像睡著了一般最易。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上竖席,一...
    開封第一講書人閱讀 52,457評(píng)論 1 311
  • 那天耘纱,我揣著相機(jī)與錄音,去河邊找鬼毕荐。 笑死束析,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的憎亚。 我是一名探鬼主播员寇,決...
    沈念sama閱讀 40,999評(píng)論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼第美!你這毒婦竟也來了蝶锋?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,914評(píng)論 0 277
  • 序言:老撾萬榮一對(duì)情侶失蹤什往,失蹤者是張志新(化名)和其女友劉穎扳缕,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,465評(píng)論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡躯舔,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,543評(píng)論 3 342
  • 正文 我和宋清朗相戀三年驴剔,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片粥庄。...
    茶點(diǎn)故事閱讀 40,675評(píng)論 1 353
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡丧失,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出惜互,到底是詐尸還是另有隱情布讹,我是刑警寧澤,帶...
    沈念sama閱讀 36,354評(píng)論 5 351
  • 正文 年R本政府宣布训堆,位于F島的核電站描验,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏蔫慧。R本人自食惡果不足惜挠乳,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,029評(píng)論 3 335
  • 文/蒙蒙 一权薯、第九天 我趴在偏房一處隱蔽的房頂上張望姑躲。 院中可真熱鬧,春花似錦盟蚣、人聲如沸黍析。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,514評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽阐枣。三九已至,卻和暖如春奄抽,著一層夾襖步出監(jiān)牢的瞬間蔼两,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,616評(píng)論 1 274
  • 我被黑心中介騙來泰國打工逞度, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留额划,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 49,091評(píng)論 3 378
  • 正文 我出身青樓档泽,卻偏偏與公主長得像俊戳,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子馆匿,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,685評(píng)論 2 360