iOS編碼規(guī)范

命名

小駝峰命名法:第一個(gè)單詞小寫字母開頭渔欢,其他單詞首字母大寫;
大駝峰命名法:所有首字母大寫色迂;
注意:公司框架使用JM開頭香缺,在命名上避開JM。

1脚草、文件命名
遵循大駝峰命名法赫悄,后面跟上對(duì)應(yīng)的名稱,不使用縮寫馏慨。如新建一個(gè)ViewController埂淮,使用命名為:HomeViewController;

2、變量命名
類成員變量写隶,屬性倔撞,局部變量,使用小寫開頭的小駝峰法慕趴。變量名的名稱盡量可以推測(cè)其用途痪蝇,具有描述性鄙陡。其中類成員變量在名稱開頭加一個(gè)下劃線(NSString *_myInstanceVariable;)這種寫法不要出現(xiàn)躏啰。

3趁矾、常量命名
這里的常量指的是宏(#define)、枚舉(enum)给僵、常量(const)等毫捣,使用小寫”k“作為前綴,名稱遵循大駝峰命名法帝际。

4蔓同、方法命名
方法名和方法參數(shù)遵循相同的規(guī)則,使用小寫開頭的小駝峰法蹲诀;
方法名不允許使用“get“前綴斑粱。

注釋

注釋形式有“//”形式的單行注釋 與“/* */”形式的多行注釋這兩種。
方法注釋采用多行注釋脯爪;(可以使用快捷鍵Command + Option + / )
方法內(nèi)注釋采用行在上方的形式则北;
屬性注釋,使用單行注釋披粟,寫在該屬性后面咒锻;

項(xiàng)目管理

1、文件夾管理


框架目錄

公司框架的目錄結(jié)構(gòu)如上圖守屉,APP的業(yè)務(wù)模塊主要放在Module下。

APP業(yè)務(wù)模塊

如上圖例子蒿辙,根據(jù)相應(yīng)的業(yè)務(wù)模塊劃分創(chuàng)建文件夾拇泛,命名力求簡(jiǎn)短達(dá)意,末尾配上中文思灌。

  • 模塊里面使用MVC的模式俺叭,必須有三個(gè)文件夾(Model、View泰偿、ViewController)
  • 界面使用storyboard熄守。storyboard的命名與外面的模塊命名相同。
    storyboard中不進(jìn)行頁(yè)面跳轉(zhuǎn)耗跛,只是頁(yè)面靜態(tài)布局裕照。一個(gè)storyboard中最多放15個(gè)ViewController,超出則新建一個(gè)storyboard调塌。
    storyboard中ViewController要使用中文標(biāo)注晋南,如下圖


    storyboard

    因?yàn)榭蚣艿脑颍瑂toryboard中ViewController的唯一標(biāo)識(shí)要與類名相同羔砾,如下圖


    image.png

    使用到自定義cell负间,cell的重用identity和cell的類名要相同偶妖。

圖片資源管理

使用Xcode自帶Images.xcassets管理圖片資源。
此處也根據(jù)模塊創(chuàng)建文件夾政溃,文件夾下面不再包含文件夾趾访。圖片命名不要包含中文,不要特殊字符董虱、數(shù)字開頭腹缩。


圖片資源管理

代碼組織

  • storyboard的控件連線放在類的實(shí)現(xiàn)文件(.m文件)頂部,如下圖


    image.png
  • 使用initController空扎、initData做初始化(框架中已經(jīng)封裝)


    image.png
  • 使用#pragma mark -在ViewController中做區(qū)域劃分藏鹊,如下圖所示,就有7個(gè)區(qū)域转锈,這樣能夠快速定位
    UINavigation:導(dǎo)航欄的操作
    Actions:控件事件
    跳轉(zhuǎn):頁(yè)面跳轉(zhuǎn)
    網(wǎng)絡(luò):網(wǎng)絡(luò)請(qǐng)求
    這些應(yīng)該是每個(gè)ViewController都有的盘寡,可以借鑒。

    image.png

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末撮慨,一起剝皮案震驚了整個(gè)濱河市竿痰,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌砌溺,老刑警劉巖影涉,帶你破解...
    沈念sama閱讀 206,311評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異规伐,居然都是意外死亡蟹倾,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,339評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門猖闪,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)鲜棠,“玉大人,你說(shuō)我怎么就攤上這事培慌』砺剑” “怎么了?”我有些...
    開封第一講書人閱讀 152,671評(píng)論 0 342
  • 文/不壞的土叔 我叫張陵吵护,是天一觀的道長(zhǎng)盒音。 經(jīng)常有香客問(wèn)我,道長(zhǎng)馅而,這世上最難降的妖魔是什么祥诽? 我笑而不...
    開封第一講書人閱讀 55,252評(píng)論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮用爪,結(jié)果婚禮上原押,老公的妹妹穿的比我還像新娘。我一直安慰自己偎血,他們只是感情好诸衔,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,253評(píng)論 5 371
  • 文/花漫 我一把揭開白布盯漂。 她就那樣靜靜地躺著,像睡著了一般笨农。 火紅的嫁衣襯著肌膚如雪就缆。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,031評(píng)論 1 285
  • 那天谒亦,我揣著相機(jī)與錄音竭宰,去河邊找鬼。 笑死份招,一個(gè)胖子當(dāng)著我的面吹牛切揭,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播锁摔,決...
    沈念sama閱讀 38,340評(píng)論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼廓旬,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了谐腰?” 一聲冷哼從身側(cè)響起孕豹,我...
    開封第一講書人閱讀 36,973評(píng)論 0 259
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎十气,沒(méi)想到半個(gè)月后励背,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,466評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡砸西,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,937評(píng)論 2 323
  • 正文 我和宋清朗相戀三年叶眉,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片籍胯。...
    茶點(diǎn)故事閱讀 38,039評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡竟闪,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出杖狼,到底是詐尸還是另有隱情,我是刑警寧澤妖爷,帶...
    沈念sama閱讀 33,701評(píng)論 4 323
  • 正文 年R本政府宣布蝶涩,位于F島的核電站,受9級(jí)特大地震影響絮识,放射性物質(zhì)發(fā)生泄漏绿聘。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,254評(píng)論 3 307
  • 文/蒙蒙 一次舌、第九天 我趴在偏房一處隱蔽的房頂上張望熄攘。 院中可真熱鬧,春花似錦彼念、人聲如沸挪圾。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,259評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)哲思。三九已至洼畅,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間棚赔,已是汗流浹背帝簇。 一陣腳步聲響...
    開封第一講書人閱讀 31,485評(píng)論 1 262
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留靠益,地道東北人丧肴。 一個(gè)月前我還...
    沈念sama閱讀 45,497評(píng)論 2 354
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像胧后,于是被迫代替她去往敵國(guó)和親芋浮。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,786評(píng)論 2 345

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

  • 一绩卤、文件目錄 項(xiàng)目基本目錄結(jié)構(gòu)如下途样,針對(duì)項(xiàng)目不同,可略作差異處理: 1.Views 存放界面層UIViewCont...
    可齊閱讀 458評(píng)論 2 2
  • 命名 Bundle id命名: 規(guī)則:采用反域名命名規(guī)則濒憋,全部使用小寫字母何暇。一級(jí)包名為com,二級(jí)包名根據(jù)應(yīng)用進(jìn)行...
    Tippi閱讀 1,620評(píng)論 0 2
  • 注釋規(guī)范 文件頭注釋 文件頭注釋采用如下格式凛驮,該注釋由xcode自動(dòng)生成裆站。如果你對(duì)其他人的原始代碼作出重大的修改,...
    yangzming閱讀 724評(píng)論 0 1
  • 約定 在我看來(lái)黔夭,開發(fā)規(guī)范像是一條可供參考的標(biāo)準(zhǔn)線宏胯。不同開發(fā)者可以根據(jù)這條標(biāo)準(zhǔn)線來(lái)規(guī)范自己的開發(fā)行為,尤其是在大的項(xiàng)...
    xxzsxxzs閱讀 615評(píng)論 1 0
  • 目錄 核心原則 命名 文件命名 視圖命名 方法命名 變量命名 圖片命名 代碼格式 空格 函數(shù)的書寫 函數(shù)調(diào)用 協(xié)議...
    忘帶充電寶de皮卡丘閱讀 507評(píng)論 0 2