iOS編碼規(guī)范整理(供參考)

每個公司甚至每個程序員都有自己的一套編碼習慣,個體不同屹徘,風格自然是迥異的走趋,為了項目的代碼質(zhì)量,團隊往往會制定自己的編碼規(guī)范噪伊。這是我們整理的編碼規(guī)范簿煌,發(fā)表出來供大家參考喲。
iOS 編碼規(guī)范
時間:2017-05-10 版本:1.0

前言:規(guī)范的編碼可以避免很多問題鉴吹,提高項目的穩(wěn)定性姨伟,也增加了易讀性和可維護性,所以豆励,現(xiàn)在初步建立一套編碼規(guī)范夺荒,之后再逐步完善。

1良蒸、命名規(guī)范
原則:
1)可讀性高技扼;
2)防止命名沖突;

類的命名
命名規(guī)范:
類名首字母大寫嫩痰,遵循OC語言的命名規(guī)范剿吻。類名要有實際的意義,如果類名太長串纺,可
以省略一些不影響實際意義的單詞丽旅,稍作簡寫椰棘。例如:
HomePageItemViewController ——> HomePageItemController
省略中間的view,大家依然知道它是一個VC魔招,并不影響實際意義和可讀性晰搀。
命名規(guī)則:
文件夾名字——類名——所屬MVC類型結(jié)尾
例如:
HomeDetailViewController,————控制器
HomeDetailCell,————————-視圖顯示器
HomeDetailModel————————數(shù)據(jù)模型

變量命名
變量名稱要有實際意義;
變量命名遵循OC的駝峰式命名規(guī)范办斑;
如果是一個View外恕,要以實際類型結(jié)尾;
變量名保持全英文結(jié)構(gòu)乡翅,不要出現(xiàn)數(shù)字鳞疲。
例如:cancelButton,titleLabel

常量命名
常量命名以m開頭蠕蚜;
遵循駝峰命名規(guī)范尚洽;
例如:#define mScreenWidth ([UIScreen mainScreen].bounds.size.width)

方法名命名
小寫字母開頭;
有實際意義靶累;
方法名前面一定要有注釋腺毫;
公有方法最好以類名開頭。
例如:
/**

  • 保存圖片到相冊
  • @param image 圖片
  • @param success 成功回調(diào)
  • @param failure 失敗回調(diào)
    /
    / + (void)saveImageToAppAlbum:(UIImage
    )image success:(void (^)())success failure:(void (^)(NSError *error))failure;

2挣柬、資源文件

圖片資源

資源文件存儲按照功能分類潮酒,按照現(xiàn)有項目舉例,項目中有“首頁”邪蛔,“訂閱”急黎,“發(fā)現(xiàn)”,“我”四個模塊侧到,圖片資源就按照如下圖大致分類:

image.png

圖片資源的命名要遵循“文件夾名字”—“子文件名字”—“圖片名字”勃教,如果圖片名字很長的情況下,可以省略最外層文件夾名字匠抗,不過不建議省略故源。圖片命名一定要是英文,禁止出現(xiàn)中文命名汞贸。

image.png

音頻心软,json,plist等其他資源文件

其他資源放在Supporting Files文件夾下著蛙,資源文件注意命名。

image.png

3耳贬、項目結(jié)構(gòu)

現(xiàn)在項目的整體結(jié)構(gòu)還是可以的踏堡,只是業(yè)務(wù)文件夾有些亂,沒怎么整理咒劲。
項目結(jié)構(gòu)上還是遵循MVC結(jié)構(gòu)顷蟆,按照功能分诫隅,一個模塊一個文件夾,再加上三方庫(如果使用pods帐偎,這個文件夾基本可以省略)逐纬,Common文件夾

image.png

Bussiness文件夾——業(yè)務(wù)

image.png

home——首頁

image.png

Common——公共

image.png

類中方法順序(這個協(xié)商決定就好)
從上到下依次是:

image.png

重寫父類的方法——> get/set——> 點擊方法 ——> 自定義方法 ——> 代理方法

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市削樊,隨后出現(xiàn)的幾起案子豁生,更是在濱河造成了極大的恐慌,老刑警劉巖漫贞,帶你破解...
    沈念sama閱讀 217,406評論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件甸箱,死亡現(xiàn)場離奇詭異,居然都是意外死亡迅脐,警方通過查閱死者的電腦和手機芍殖,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,732評論 3 393
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來谴蔑,“玉大人豌骏,你說我怎么就攤上這事∫В” “怎么了窃躲?”我有些...
    開封第一講書人閱讀 163,711評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長成榜。 經(jīng)常有香客問我框舔,道長,這世上最難降的妖魔是什么赎婚? 我笑而不...
    開封第一講書人閱讀 58,380評論 1 293
  • 正文 為了忘掉前任刘绣,我火速辦了婚禮,結(jié)果婚禮上挣输,老公的妹妹穿的比我還像新娘纬凤。我一直安慰自己,他們只是感情好撩嚼,可當我...
    茶點故事閱讀 67,432評論 6 392
  • 文/花漫 我一把揭開白布停士。 她就那樣靜靜地躺著,像睡著了一般完丽。 火紅的嫁衣襯著肌膚如雪恋技。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,301評論 1 301
  • 那天逻族,我揣著相機與錄音蜻底,去河邊找鬼。 笑死聘鳞,一個胖子當著我的面吹牛薄辅,可吹牛的內(nèi)容都是我干的要拂。 我是一名探鬼主播,決...
    沈念sama閱讀 40,145評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼站楚,長吁一口氣:“原來是場噩夢啊……” “哼脱惰!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起窿春,我...
    開封第一講書人閱讀 39,008評論 0 276
  • 序言:老撾萬榮一對情侶失蹤拉一,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后谁尸,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體舅踪,經(jīng)...
    沈念sama閱讀 45,443評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,649評論 3 334
  • 正文 我和宋清朗相戀三年良蛮,在試婚紗的時候發(fā)現(xiàn)自己被綠了抽碌。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,795評論 1 347
  • 序言:一個原本活蹦亂跳的男人離奇死亡决瞳,死狀恐怖货徙,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情皮胡,我是刑警寧澤痴颊,帶...
    沈念sama閱讀 35,501評論 5 345
  • 正文 年R本政府宣布,位于F島的核電站屡贺,受9級特大地震影響蠢棱,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜甩栈,卻給世界環(huán)境...
    茶點故事閱讀 41,119評論 3 328
  • 文/蒙蒙 一泻仙、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧量没,春花似錦玉转、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,731評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至袭灯,卻和暖如春刺下,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背稽荧。 一陣腳步聲響...
    開封第一講書人閱讀 32,865評論 1 269
  • 我被黑心中介騙來泰國打工橘茉, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 47,899評論 2 370
  • 正文 我出身青樓捺癞,卻偏偏與公主長得像,于是被迫代替她去往敵國和親构挤。 傳聞我的和親對象是個殘疾皇子髓介,可洞房花燭夜當晚...
    茶點故事閱讀 44,724評論 2 354

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

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,110評論 25 707
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn)筋现,斷路器唐础,智...
    卡卡羅2017閱讀 134,654評論 18 139
  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 46,810評論 6 342
  • 就像是有人喜歡炒股一膨,而有的人喜歡炒“物”,就比如一些私人收藏的古董字畫洒沦,又或者是一些名貴少見的藥材等豹绪。前幾天有個新...
    大能貓貓閱讀 292評論 0 0
  • 清除浮動之前需注意兩點:1、清除浮動一定要在完成布局之后申眼。2瞒津、清除浮動必須與前面的浮動標簽屬于同級關(guān)系。 1括尸、空標...
    蚊子簡叔閱讀 246評論 0 0