iOS開發(fā)規(guī)范

一、命名規(guī)則

1剃毒、使用專業(yè)名詞病袄,如iOS不要寫成IOS或者ios;(這個真的強迫癥每次看到好多人寫錯心里真的有疙瘩赘阀,甚至好多大牛都寫錯益缠,嗚嗚~~~~(>_<)~~~~)

2、盡量使用美式英語拼寫確保和蘋果公司的API一致基公;

eg:var tintColor = "red"幅慌;NSString *userName = @"zhanglizzy";

2轰豆、使用駝峰式的描述性命名方式胰伍,為類,方法秒咨,變量等命名喇辽。類名的首字母應(yīng)該大寫掌挚,而方法和變量的首字母使用小寫字符雨席;

3、命名方式一定要能看出該名字是用來干嘛的吠式,可以選擇某些已被公認(rèn)的縮寫形式陡厘,eg:button可寫成btn,viewController可寫成VC特占;

4糙置、UI控件命名格式:控件名+控件類型,eg“用戶名文本框”:userNameLabel是目,“密碼輸入框”:passwordField谤饭;

5、具體參考蘋果官方文檔。

二揉抵、常量定義規(guī)范

1亡容、字符串常量定義規(guī)范:

接口URL、通知名等冤今,使用static let k… = “”命名闺兢;

Notification格式為: [Name of associatedclass] + [Did | will] + [UniquePartOfName] +Nofification(eg: UIKeyboardWillShowNotification);

2戏罢、公共常量定義在/ThankYou/Main/Common/Macro.swift文件中屋谭,用一個結(jié)構(gòu)體存儲對應(yīng)的常量。

三龟糕、間隔

1桐磁、方法的花括號以及其他花括號(if / else / switch / while等等)總是跟語句在同一行開始,新起一行結(jié)束翩蘸;(關(guān)于花括號的故事糾結(jié)了很久所意,現(xiàn)在堅持這么寫是看蘋果官方推出來的)如:

if user.isHappy {

//Do something

} else {

//Do something

}

2、方法之間應(yīng)該總是用一個空行進行分割以提高視覺及結(jié)構(gòu)上的清晰度催首。

四扶踊、使用標(biāo)記分類代碼塊

每類方法前做一個Mark標(biāo)記,以便于直接查看標(biāo)記的方法名郎任,而不用盲目的去查找秧耗,使整個目錄清晰明了。如:

// MARK: - lifeCycle

override func viewDidLoad() {

super.viewDidLoad()

setup()

}

// MARK: - private Method

funcsetup() {

}

// MARK: - clickAction

func clickAction() {

sendMessageRequest() {

}

// MARK: - Request

func sendMessageRequest() {

}

五舶治、注釋規(guī)范

1分井、在每個類前添加類的用途描述:

*@author zhanglizzy, 16-04-12 11:08:29

*

*@brief用戶數(shù)據(jù)單例

*

*@since 1.0

@interface UserSingleton : NSObject

2、方法注釋使用VVDocumenter插件注釋工具(可惜了現(xiàn)在Xcode8已經(jīng)不能使用插件了霉猛,嗚嗚)

3尺锚、屬性注釋使用@/**<注釋信息* /(可使用語句塊/**<<#注釋信息#>*/,這個很贊惜浅,在方法后注釋瘫辩,調(diào)用時可提示注釋的內(nèi)容)

六、適配規(guī)范

1坛悉、使用Masonry第三方框架進行界面適配(推薦使用)

2伐厌、可設(shè)置frame相對布局方式

七、控件的封裝

1裸影、封裝的控件必須獨立于框架挣轨,零耦合;

2轩猩、拋出的接口參數(shù)必須明確卷扮,簡明扼要荡澎;

3、注釋格式要規(guī)范晤锹,切帶使用說明衔瓮。

八、SVN使用規(guī)范

1抖甘、先更新热鞍,再提交;

2衔彻、涉及到大范圍更新提交時薇宠,操作之前先備份本地代碼;

3艰额、如需替換文件澄港,則必須先刪掉被替換文件,提交柄沮,然后添加新文件再提交回梧。

九、版本迭代要有清晰明確的版本紀(jì)錄

1祖搓、明確紀(jì)錄此次版本切割制作版本號狱意;

2、此次版本所包含新增功能拯欧;

3详囤、以及改動和修復(fù)的功能。

eg:

============== 1.1版本分界線=================

1镐作、獲取好友列表

2藏姐、BUG優(yōu)化

3、發(fā)件箱消息推送

4该贾、社交分享

5羔杨、留言接口調(diào)整

============== 1.1版本分界線==================

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市杨蛋,隨后出現(xiàn)的幾起案子兜材,更是在濱河造成了極大的恐慌,老刑警劉巖六荒,帶你破解...
    沈念sama閱讀 216,651評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件护姆,死亡現(xiàn)場離奇詭異矾端,居然都是意外死亡掏击,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,468評論 3 392
  • 文/潘曉璐 我一進店門秩铆,熙熙樓的掌柜王于貴愁眉苦臉地迎上來砚亭,“玉大人灯变,你說我怎么就攤上這事⊥北欤” “怎么了添祸?”我有些...
    開封第一講書人閱讀 162,931評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長寻仗。 經(jīng)常有香客問我刃泌,道長,這世上最難降的妖魔是什么署尤? 我笑而不...
    開封第一講書人閱讀 58,218評論 1 292
  • 正文 為了忘掉前任耙替,我火速辦了婚禮,結(jié)果婚禮上曹体,老公的妹妹穿的比我還像新娘俗扇。我一直安慰自己,他們只是感情好箕别,可當(dāng)我...
    茶點故事閱讀 67,234評論 6 388
  • 文/花漫 我一把揭開白布铜幽。 她就那樣靜靜地躺著,像睡著了一般串稀。 火紅的嫁衣襯著肌膚如雪除抛。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,198評論 1 299
  • 那天母截,我揣著相機與錄音镶殷,去河邊找鬼。 笑死微酬,一個胖子當(dāng)著我的面吹牛绘趋,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播颗管,決...
    沈念sama閱讀 40,084評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼陷遮,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了垦江?” 一聲冷哼從身側(cè)響起帽馋,我...
    開封第一講書人閱讀 38,926評論 0 274
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎比吭,沒想到半個月后绽族,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,341評論 1 311
  • 正文 獨居荒郊野嶺守林人離奇死亡衩藤,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,563評論 2 333
  • 正文 我和宋清朗相戀三年吧慢,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片赏表。...
    茶點故事閱讀 39,731評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡检诗,死狀恐怖匈仗,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情逢慌,我是刑警寧澤悠轩,帶...
    沈念sama閱讀 35,430評論 5 343
  • 正文 年R本政府宣布,位于F島的核電站攻泼,受9級特大地震影響火架,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜忙菠,卻給世界環(huán)境...
    茶點故事閱讀 41,036評論 3 326
  • 文/蒙蒙 一距潘、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧只搁,春花似錦音比、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,676評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至焰望,卻和暖如春骚亿,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背熊赖。 一陣腳步聲響...
    開封第一講書人閱讀 32,829評論 1 269
  • 我被黑心中介騙來泰國打工来屠, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人震鹉。 一個月前我還...
    沈念sama閱讀 47,743評論 2 368
  • 正文 我出身青樓俱笛,卻偏偏與公主長得像,于是被迫代替她去往敵國和親传趾。 傳聞我的和親對象是個殘疾皇子迎膜,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,629評論 2 354

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

  • iOS開發(fā)規(guī)范 引子 在看下面之前,大家自我檢測一下自己寫的代碼是否規(guī)范浆兰,代碼風(fēng)格是否過于迥異閱讀困難磕仅?可以相互閱...
    BGDane閱讀 1,380評論 1 4
  • 導(dǎo)語: 為規(guī)范部門 iOS開發(fā),特制定本文檔簸呈,供各位同仁參考榕订。 語言 使用US英語, 不要使用拼音蜕便。e.g:UIC...
    攻城獅V閱讀 773評論 0 0
  • 版權(quán)聲明:本文為博主原創(chuàng)文章劫恒,未經(jīng)博主允許不得轉(zhuǎn)載。轉(zhuǎn)載請注明轉(zhuǎn)至Z.MJun的簡書 1. 每一行的字?jǐn)?shù)限制 80...
    ZMJun閱讀 1,530評論 0 1
  • 命名原則 1.基本原則 (1)清晰玩裙。 命名應(yīng)該是以清晰為主兼贸、簡潔為輔〕越Γ總的來講不要使用單詞的簡寫溶诞,除了使用非常常見...
    MichaelHuyp閱讀 3,206評論 2 28
  • 每一首歌都有自己的情緒,聽歌的時候腦海里會形成一個畫面决侈,或者是一個片段螺垢,又或者是一種抓不住的感覺。吶赖歌,你以后想做什...
    石明達閱讀 248評論 0 1