iOS開(kāi)發(fā)文檔

命名

  • 命名統(tǒng)一使用駝峰命名法;只采納有廣為人知含義的縮寫(xiě)需纳,比如info芦倒、msg、UI不翩、HTTP這類(lèi)兵扬。自造的縮寫(xiě)不被認(rèn)可】隍穑總體的命名原則是清晰和一致器钟,避免歧義,同樣要確保類(lèi)名需要大寫(xiě)字母開(kāi)頭妙蔗。
  • 公共類(lèi)名需要結(jié)合項(xiàng)目名稱(chēng)來(lái)命名傲霸,確保整個(gè)項(xiàng)目中的自定義類(lèi)的名稱(chēng)開(kāi)頭是統(tǒng)一的。
  • 模塊內(nèi)類(lèi)名命名需結(jié)合功能或者模塊眉反,并且尾部要帶上該類(lèi)的類(lèi)型昙啄,比如UIViewController的子類(lèi)命名為JasonIndexController。
  • 成員變量命名小寫(xiě)字母開(kāi)頭寸五,使用下劃線作為變量的前綴梳凛;屬性和局部變量命名不需要使用下劃線作為變量的前綴或者后綴,全局變量使用下劃線作為變量的后綴梳杏。
  • 方法命名小寫(xiě)字母開(kāi)頭(方法以大寫(xiě)縮略詞開(kāi)始的除外)韧拒,文件夾首字母大寫(xiě)開(kāi)頭。不要使用下劃線開(kāi)頭作為方法的前綴十性。
  • 項(xiàng)目中所有Group或者文件名稱(chēng)(圖片名字等)叭莫,不要使用漢字命名,盡量使用英文命名烁试,國(guó)內(nèi)特有名詞可以使用拼音雇初。
  • 圖片命名以英文小寫(xiě)“模塊名_圖片名”來(lái)命名,并且同樣不能使用中文减响。

Objective-C下的cocoa編碼規(guī)范

  • 使用#pragma mark 來(lái)分類(lèi)方法靖诗,參考以下結(jié)構(gòu):#pragma mark – Life Cycle郭怪。
  • .h文件中使用@class聲明OC文件; .m文件中使用#import引入oc文件。
  • 盡量減少公開(kāi)的api接口數(shù)量
  • 枚舉的定義使用如下的方式:
     typedef NS_ENUM(NSUInteger, UISearchBarStyle) {
      UISearchBarStyleDefault,    // currently UISearchBarStyleProminent
      UISearchBarStyleProminent,  // used my Mail, Messages and Contacts
      UISearchBarStyleMinimal     // used by Calendar, Notes and Music
    }
    

注釋要求

新版Xcode自帶有添加注釋的功能

  • 單行注釋?zhuān)涸诜椒ǖ牡胤桨?Command+/
  • 方法注釋?zhuān)旖萱I是Command + Option + /(需要在方法名的上面(空白)的地方按 Command + Option + / 才管用)
  • 在新建一個(gè)類(lèi)的時(shí)候刊橘,需要在頭文件中添加注釋?zhuān)瑏?lái)表明這個(gè)類(lèi)的作用鄙才。
  • 一些過(guò)于簡(jiǎn)單的注釋盡量不要加。

其他

  • 懶加載代碼放在最底部
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末促绵,一起剝皮案震驚了整個(gè)濱河市攒庵,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌败晴,老刑警劉巖浓冒,帶你破解...
    沈念sama閱讀 216,496評(píng)論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異尖坤,居然都是意外死亡稳懒,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,407評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門(mén)慢味,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)场梆,“玉大人,你說(shuō)我怎么就攤上這事纯路』蛴停” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 162,632評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵驰唬,是天一觀的道長(zhǎng)顶岸。 經(jīng)常有香客問(wèn)我,道長(zhǎng)定嗓,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,180評(píng)論 1 292
  • 正文 為了忘掉前任萍桌,我火速辦了婚禮宵溅,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘上炎。我一直安慰自己恃逻,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,198評(píng)論 6 388
  • 文/花漫 我一把揭開(kāi)白布藕施。 她就那樣靜靜地躺著寇损,像睡著了一般。 火紅的嫁衣襯著肌膚如雪裳食。 梳的紋絲不亂的頭發(fā)上矛市,一...
    開(kāi)封第一講書(shū)人閱讀 51,165評(píng)論 1 299
  • 那天,我揣著相機(jī)與錄音诲祸,去河邊找鬼浊吏。 笑死而昨,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的找田。 我是一名探鬼主播歌憨,決...
    沈念sama閱讀 40,052評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼墩衙!你這毒婦竟也來(lái)了务嫡?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 38,910評(píng)論 0 274
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤漆改,失蹤者是張志新(化名)和其女友劉穎心铃,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體籽懦,經(jīng)...
    沈念sama閱讀 45,324評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡于个,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,542評(píng)論 2 332
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了暮顺。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片厅篓。...
    茶點(diǎn)故事閱讀 39,711評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖捶码,靈堂內(nèi)的尸體忽然破棺而出羽氮,到底是詐尸還是另有隱情,我是刑警寧澤惫恼,帶...
    沈念sama閱讀 35,424評(píng)論 5 343
  • 正文 年R本政府宣布档押,位于F島的核電站,受9級(jí)特大地震影響祈纯,放射性物質(zhì)發(fā)生泄漏令宿。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,017評(píng)論 3 326
  • 文/蒙蒙 一腕窥、第九天 我趴在偏房一處隱蔽的房頂上張望粒没。 院中可真熱鬧,春花似錦簇爆、人聲如沸癞松。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,668評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)响蓉。三九已至,卻和暖如春哨毁,著一層夾襖步出監(jiān)牢的瞬間枫甲,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,823評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留言秸,地道東北人软能。 一個(gè)月前我還...
    沈念sama閱讀 47,722評(píng)論 2 368
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像举畸,于是被迫代替她去往敵國(guó)和親查排。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,611評(píng)論 2 353

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

  • Spring Cloud為開(kāi)發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見(jiàn)模式的工具(例如配置管理抄沮,服務(wù)發(fā)現(xiàn)跋核,斷路器,智...
    卡卡羅2017閱讀 134,651評(píng)論 18 139
  • 一. 代碼規(guī)范 為了方便項(xiàng)目維護(hù)及交接叛买,特制定以下代碼書(shū)寫(xiě)規(guī)范砂代,如有不妥之處,歡迎批評(píng)指正率挣,有什么建議 QQ: 8...
    Balopy閱讀 6,620評(píng)論 4 7
  • 一刻伊、Python簡(jiǎn)介和環(huán)境搭建以及pip的安裝 4課時(shí)實(shí)驗(yàn)課主要內(nèi)容 【Python簡(jiǎn)介】: Python 是一個(gè)...
    _小老虎_閱讀 5,744評(píng)論 0 10
  • 官網(wǎng) 中文版本 好的網(wǎng)站 Content-type: text/htmlBASH Section: User ...
    不排版閱讀 4,380評(píng)論 0 5